Adds together a list of fluxes. More...
#include <ComplexSurfaceFlux.H>
Inheritance diagram for CompositeFlux:
Collaboration diagram for CompositeFlux:
Public Member Functions | |
| CompositeFlux (const Vector< SurfaceFlux *> &a_fluxes) | |
| virtual | ~CompositeFlux () |
| 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... | |
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
Adds together a list of fluxes.
Run-time configuration is carried out in SurfaceFlux::parse. If the string A.B.C.type = compositeFlux is found, then the expected form is:
A.B.C.nElements = <int>(number of fluxes)A.B.C.element0 = <valid SurfaceFlux type>A.B.C.element1 = <valid SurfaceFlux type>- ...
A.B.C.elementn = <valid SurfaceFlux type>
Constructor & Destructor Documentation
◆ CompositeFlux()
| CompositeFlux::CompositeFlux | ( | const Vector< SurfaceFlux *> & | a_fluxes | ) |
References CompositeFlux().
Referenced by CompositeFlux().
◆ ~CompositeFlux()
|
virtual |
Member Function Documentation
◆ new_surfaceFlux()
|
virtual |
factory method
return a pointer to a new SurfaceFlux object
Implements SurfaceFlux.
Referenced by SurfaceFlux::parse().
◆ surfaceThicknessFlux()
|
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:
