simple implementation of SurfaceFlux which sets surface flux to a constant in space and time More...

#include <SurfaceFlux.H>

Inheritance diagram for constantFlux:

Collaboration diagram for constantFlux:

Public Member Functions
	constantFlux ()

	constantFlux (const Real &a_fluxVal)
	Construct a constantFlux with a given constant value. More...

virtual	~constantFlux ()

virtual SurfaceFlux *	new_surfaceFlux ()
	factory method: return a pointer to a new SurfaceFlux object More...

virtual void	surfaceThicknessFlux (LevelData< FArrayBox > &a_flux, const AmrIceBase &a_amrIce, int a_level, Real a_dt)
	define source term for thickness evolution and place it in flux More...

void	setFluxVal (const Real &a_fluxVal)
	set flux value in meters/year More...

Public Member Functions inherited from SurfaceFlux
virtual	~SurfaceFlux ()
	virtual destructor More...

virtual void	evaluate (LevelData< FArrayBox > &a_data, const AmrIceBase &a_amrIce, int a_level, Real a_dt)
	Sub-classes of this class turned out to be useful for various data apart from thickness fluxes... More...

Protected Attributes
Real	m_fluxVal

bool	m_isValSet

Additional Inherited Members
Static Public Member Functions inherited from SurfaceFlux
static SurfaceFlux *	parse (const char *a_prefix)
	assemble a SurfaceFlux* object from ParmParse inputs More...

Detailed Description

simple implementation of SurfaceFlux which sets surface flux to a constant in space and time

Run-time configuration is carried out in SurfaceFlux::parse. If the string A.B.C.type = constantFlux is found, then the expected form is:

A.B.C.flux_value = <float>

Constructor & Destructor Documentation

◆ constantFlux() [1/2]

constantFlux::constantFlux ( )

Referenced by new_surfaceFlux(), and SurfaceFlux::parse().

◆ constantFlux() [2/2]

constantFlux::constantFlux ( const Real & a_fluxVal )

inline

Construct a constantFlux with a given constant value.

◆ ~constantFlux()

virtual constantFlux::~constantFlux ( )

inlinevirtual

References SurfaceFlux::new_surfaceFlux(), and SurfaceFlux::surfaceThicknessFlux().

Member Function Documentation

◆ new_surfaceFlux()

SurfaceFlux * constantFlux::new_surfaceFlux ( )

virtual

factory method: return a pointer to a new SurfaceFlux object

Implements SurfaceFlux.

References constantFlux(), m_fluxVal, and m_isValSet.

◆ setFluxVal()

void constantFlux::setFluxVal ( const Real & a_fluxVal )

set flux value in meters/year

References m_fluxVal, and m_isValSet.

Referenced by CrevasseCalvingModel::CrevasseCalvingModel(), and SurfaceFlux::parse().

◆ surfaceThicknessFlux()

void constantFlux::surfaceThicknessFlux	(	LevelData< FArrayBox > &	a_flux,
		const AmrIceBase &	a_amrIce,
		int	a_level,
		Real	a_dt
	)

virtual

define source term for thickness evolution and place it in flux

dt is included in case one needs integrals or averages over a timestep

Implements SurfaceFlux.

References m_fluxVal, and m_isValSet.

Member Data Documentation

◆ m_fluxVal

Real constantFlux::m_fluxVal

protected

Referenced by new_surfaceFlux(), setFluxVal(), and surfaceThicknessFlux().

◆ m_isValSet

bool constantFlux::m_isValSet