MaskedFlux Class Reference

Applies a different surface flux depending on the mask. More...

#include <ComplexSurfaceFlux.H>

Inheritance diagram for MaskedFlux:

Collaboration diagram for MaskedFlux:

Public Member Functions
	MaskedFlux (SurfaceFlux *a_groundedIceFlux, SurfaceFlux *a_floatingIceFlux, SurfaceFlux *a_openSeaFlux, SurfaceFlux *a_openLandFlux)
	Construct a MaskedFlux given its component fluxes. More...
virtual	~MaskedFlux ()
virtual SurfaceFlux *	new_surfaceFlux ()
	factory method 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...

Protected Attributes
SurfaceFlux *	m_groundedIceFlux
SurfaceFlux *	m_floatingIceFlux
SurfaceFlux *	m_openSeaFlux
SurfaceFlux *	m_openLandFlux

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

Applies a different surface flux depending on the mask.

Applies a different surface fluxes for grounded and floating ice and for open sea and land.

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

• A.B.C.grounded = <valid SurfaceFlux type (optional, default ZeroFlux) >
• A.B.C.floating = <valid SurfaceFlux type (optional, default ZeroFlux) >
• A.B.C.openland = <valid SurfaceFlux type (optional, default ZeroFlux) >
• A.B.C.opensea = <valid SurfaceFlux type (optional, default ZeroFlux) >

Constructor & Destructor Documentation

MaskedFlux()

MaskedFlux::MaskedFlux	(	SurfaceFlux *	a_groundedIceFlux,
		SurfaceFlux *	a_floatingIceFlux,
		SurfaceFlux *	a_openSeaFlux,
		SurfaceFlux *	a_openLandFlux
	)

Construct a MaskedFlux given its component fluxes.

constructor

Parameters

a_groundedIceFlux	flux over grounded ice
a_floatingIceFlux	flux over floating ice
a_openSeaFlux	flux over ice free areas below sea level
a_openLandFlux	flux over ice free areas above sea level

References MaskedFlux().

Referenced by MaskedFlux().

~MaskedFlux()

virtual MaskedFlux::~MaskedFlux ( )

inlinevirtual

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

Member Function Documentation

new_surfaceFlux()

SurfaceFlux * MaskedFlux::new_surfaceFlux ( )

virtual

factory method

return a pointer to a new SurfaceFlux object

Implements SurfaceFlux.

References m_floatingIceFlux, m_groundedIceFlux, m_openLandFlux, m_openSeaFlux, and SurfaceFlux::new_surfaceFlux().

surfaceThicknessFlux()

void MaskedFlux::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.

References AmrIceBase::geometry(), m_floatingIceFlux, m_groundedIceFlux, m_openLandFlux, m_openSeaFlux, and SurfaceFlux::surfaceThicknessFlux().

Member Data Documentation

m_floatingIceFlux

SurfaceFlux* MaskedFlux::m_floatingIceFlux

protected

Referenced by new_surfaceFlux(), and surfaceThicknessFlux().

m_groundedIceFlux

SurfaceFlux* MaskedFlux::m_groundedIceFlux

protected

Referenced by new_surfaceFlux(), and surfaceThicknessFlux().

m_openLandFlux

SurfaceFlux* MaskedFlux::m_openLandFlux

protected

Referenced by new_surfaceFlux(), and surfaceThicknessFlux().

m_openSeaFlux

SurfaceFlux* MaskedFlux::m_openSeaFlux

protected

Referenced by new_surfaceFlux(), and surfaceThicknessFlux().

---

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

• ComplexSurfaceFlux.H
• ComplexSurfaceFlux.cpp