PISM, A Parallel Ice Sheet Model  stable v1.2 committed by Constantine Khrulev on 2020-02-11 20:24:05 -0900
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
pism::YieldStress Class Referenceabstract

The PISM basal yield stress model interface (virtual base class) More...

#include <YieldStress.hh>

+ Inheritance diagram for pism::YieldStress:

Public Member Functions

 YieldStress (IceGrid::ConstPtr g)
 
virtual ~YieldStress ()
 
void restart (const File &input_file, int record)
 
void bootstrap (const File &input_file, const YieldStressInputs &inputs)
 
void init (const YieldStressInputs &inputs)
 
void update (const YieldStressInputs &inputs, double t, double dt)
 
const IceModelVec2Sbasal_material_yield_stress ()
 
std::string name () const
 
- Public Member Functions inherited from pism::Component
 Component (IceGrid::ConstPtr g)
 
virtual ~Component ()
 
DiagnosticList diagnostics () const
 
TSDiagnosticList ts_diagnostics () const
 
IceGrid::ConstPtr grid () 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...
 

Protected Member Functions

virtual void restart_impl (const File &input_file, int record)=0
 
virtual void bootstrap_impl (const File &input_file, const YieldStressInputs &inputs)=0
 
virtual void init_impl (const YieldStressInputs &inputs)=0
 
virtual void update_impl (const YieldStressInputs &inputs, double t, double dt)=0
 
virtual void define_model_state_impl (const File &output) const
 
virtual void write_model_state_impl (const File &output) const
 The default (empty implementation). More...
 
DiagnosticList diagnostics_impl () const
 
- Protected Member Functions inherited from pism::Component
virtual MaxTimestep max_timestep_impl (double t) const
 
virtual TSDiagnosticList ts_diagnostics_impl () const
 
virtual void regrid (const std::string &module_name, IceModelVec &variable, RegriddingFlag flag=NO_REGRID_WITHOUT_REGRID_VARS)
 

Protected Attributes

IceModelVec2S m_basal_yield_stress
 
std::string m_name
 
- Protected Attributes inherited from pism::Component
const IceGrid::ConstPtr m_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...
 

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...
 

Detailed Description

The PISM basal yield stress model interface (virtual base class)

Definition at line 44 of file YieldStress.hh.


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