class which multiplies two surface fluxes together More...
#include <ComplexSurfaceFlux.H>
Public Member Functions | |
| ProductSurfaceFlux (SurfaceFlux *a_Flux1, SurfaceFlux *a_flux2) | |
| virtual | ~ProductSurfaceFlux () |
| destructor More... | |
| 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_flux1 |
| SurfaceFlux * | m_flux2 |
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
class which multiplies two surface fluxes together
Useful for using an externally defined mask, among other things.
Run-time configuration is carried out in SurfaceFlux::parse. If the string A.B.C.type = productFlux is found, then the expected form is:
A.B.C.flux1 = <valid SurfaceFlux type>A.B.C.flux2 = <valid SurfaceFlux type>
Constructor & Destructor Documentation
◆ ProductSurfaceFlux()
| ProductSurfaceFlux::ProductSurfaceFlux | ( | SurfaceFlux * | a_Flux1, |
| SurfaceFlux * | a_flux2 | ||
| ) |
References m_flux1, m_flux2, and ProductSurfaceFlux().
Referenced by ProductSurfaceFlux().
◆ ~ProductSurfaceFlux()
|
virtual |
destructor
Member Function Documentation
◆ new_surfaceFlux()
|
virtual |
factory method
return a pointer to a new SurfaceFlux object
Implements SurfaceFlux.
References m_flux1, m_flux2, and SurfaceFlux::new_surfaceFlux().
◆ surfaceThicknessFlux()
|
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. flux should be defined in meters/second in the current implementation.
Implements SurfaceFlux.
References m_flux1, m_flux2, and SurfaceFlux::surfaceThicknessFlux().
Member Data Documentation
◆ m_flux1
|
protected |
Referenced by new_surfaceFlux(), ProductSurfaceFlux(), and surfaceThicknessFlux().
◆ m_flux2
|
protected |
Referenced by new_surfaceFlux(), ProductSurfaceFlux(), and surfaceThicknessFlux().
The documentation for this class was generated from the following files:
