AxbyFlux Class Reference

Provide the flux a*x + b*y, where x,y are fluxes and a,b are scalars. More...

#include <ComplexSurfaceFlux.H>

Inheritance diagram for AxbyFlux:

Collaboration diagram for AxbyFlux:

Public Member Functions
	AxbyFlux (const Real &a_a, SurfaceFlux *a_x, const Real &a_b, SurfaceFlux *a_y)
	Construct an AxbyFlux a*x + b*y given two fluxes x,y and two scalars a,b. More...
virtual	~AxbyFlux ()
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...
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...

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

Provide the flux a*x + b*y, where x,y are fluxes and a,b are scalars.

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

• A.B.C.a = <float>
• A.B.C.x.type = <valid SurfaceFlux type>
• A.B.C.x.<etc> = <the remaining A.B.C.x configuration>
• A.B.C.b = <float>
• A.B.C.y.type = <valid SurfaceFlux type> -A.B.C.y.<etc> = <the remaining A.B.C.y configuration>

Constructor & Destructor Documentation

AxbyFlux()

AxbyFlux::AxbyFlux	(	const Real &	a_a,
		SurfaceFlux *	a_x,
		const Real &	a_b,
		SurfaceFlux *	a_y
	)

Construct an AxbyFlux a*x + b*y given two fluxes x,y and two scalars a,b.

Parameters

a_a	scalar a
a_x	flux x
a_b	scalar b
a_y	flux y

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

Referenced by AxbyFlux().

~AxbyFlux()

AxbyFlux::~AxbyFlux ( )

virtual

Member Function Documentation

new_surfaceFlux()

SurfaceFlux * AxbyFlux::new_surfaceFlux ( )

virtual

factory method: return a pointer to a new SurfaceFlux object

Implements SurfaceFlux.

surfaceThicknessFlux()

void AxbyFlux::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

Parameters

a_flux	output flux data
a_amrIce	reference to the ice sheet state
a_level	mesh level of a_flux
a_dt	current timestep

a_dt is included in case one needs integrals or averages over a timestep. flux should be defined in meters per year in the current implementation.

Implements SurfaceFlux.

---

The documentation for this class was generated from the following files:

• ComplexSurfaceFlux.H
• ComplexSurfaceFlux.cpp