PISM, A Parallel Ice Sheet Model  stable v2.1-1-g6902d5502 committed by Ed Bueler on 2023-12-20 08:38:27 -0800
Public Member Functions | Private Member Functions | Private Attributes | List of all members
pism::frontalmelt::Constant Class Reference

A class implementing a constant (in terms of the ocean inputs) frontal melt model. Uses a configuration parameter for the frontal melt rate. More...

#include <Constant.hh>

+ Inheritance diagram for pism::frontalmelt::Constant:

Public Member Functions

 Constant (std::shared_ptr< const Grid > g)
 
virtual ~Constant ()=default
 
- Public Member Functions inherited from pism::frontalmelt::FrontalMelt
 FrontalMelt (std::shared_ptr< const Grid > g, std::shared_ptr< FrontalMelt > input)
 
 FrontalMelt (std::shared_ptr< const Grid > g)
 
virtual ~FrontalMelt ()=default
 
void init (const Geometry &geometry)
 
void update (const FrontalMeltInputs &inputs, double t, double dt)
 
const array::Scalarfrontal_melt_rate () const
 
const array::Scalarretreat_rate () const
 
- Public Member Functions inherited from pism::Component
 Component (std::shared_ptr< const Grid > grid)
 
virtual ~Component ()=default
 
DiagnosticList diagnostics () const
 
TSDiagnosticList ts_diagnostics () const
 
std::shared_ptr< const Gridgrid () const
 
const Timetime () const
 
const Profilingprofiling () const
 
void define_model_state (const File &output) const
 Define model state variables in an output file. More...
 
void write_model_state (const File &output) const
 Write model state variables to an output file. More...
 
MaxTimestep max_timestep (double t) const
 Reports the maximum time-step the model can take at time t. More...
 

Private Member Functions

void init_impl (const Geometry &geometry)
 
void update_impl (const FrontalMeltInputs &inputs, double t, double dt)
 
const array::Scalarfrontal_melt_rate_impl () const
 
MaxTimestep max_timestep_impl (double t) const
 

Private Attributes

std::shared_ptr< array::Scalarm_frontal_melt_rate
 

Additional Inherited Members

- Protected Types inherited from pism::Component
enum  RegriddingFlag { REGRID_WITHOUT_REGRID_VARS , NO_REGRID_WITHOUT_REGRID_VARS }
 This flag determines whether a variable is read from the -regrid_file file even if it is not listed among variables in -regrid_vars. More...
 
- Protected Member Functions inherited from pism::frontalmelt::FrontalMelt
virtual void define_model_state_impl (const File &output) const
 The default (empty implementation). More...
 
virtual void write_model_state_impl (const File &output) const
 The default (empty implementation). More...
 
virtual DiagnosticList diagnostics_impl () const
 
virtual TSDiagnosticList ts_diagnostics_impl () const
 
void compute_retreat_rate (const Geometry &geometry, const array::Scalar &frontal_melt_rate, array::Scalar &result) const
 
bool apply (const array::CellType1 &M, int i, int j) const
 
- Protected Member Functions inherited from pism::Component
void regrid (const std::string &module_name, array::Array &variable, RegriddingFlag flag=NO_REGRID_WITHOUT_REGRID_VARS)
 
- Protected Attributes inherited from pism::frontalmelt::FrontalMelt
std::shared_ptr< FrontalMeltm_input_model
 
array::Scalar m_retreat_rate
 
bool m_include_floating_ice
 
- Protected Attributes inherited from pism::Component
const std::shared_ptr< const Gridm_grid
 grid used by this component More...
 
const Config::ConstPtr m_config
 configuration database used by this component More...
 
const units::System::Ptr m_sys
 unit system used by this component More...
 
const Logger::ConstPtr m_log
 logger (for easy access) More...
 

Detailed Description

A class implementing a constant (in terms of the ocean inputs) frontal melt model. Uses a configuration parameter for the frontal melt rate.

Definition at line 29 of file Constant.hh.


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