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::RegionalYieldStress Class Reference

#include <RegionalYieldStress.hh>

+ Inheritance diagram for pism::RegionalYieldStress:

Public Member Functions

 RegionalYieldStress (std::shared_ptr< YieldStress > input)
 
virtual ~RegionalYieldStress ()=default
 
- Public Member Functions inherited from pism::YieldStress
 YieldStress (std::shared_ptr< const Grid > g)
 
virtual ~YieldStress ()=default
 
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 array::Scalarbasal_material_yield_stress ()
 
std::string name () 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 restart_impl (const File &input_file, int record)
 
void bootstrap_impl (const File &input_file, const YieldStressInputs &inputs)
 
void init_impl (const YieldStressInputs &inputs)
 
void update_impl (const YieldStressInputs &inputs, double t, double dt)
 
MaxTimestep max_timestep_impl (double t) const
 
void define_model_state_impl (const File &output) const
 
void write_model_state_impl (const File &output) const
 The default (empty implementation). More...
 
DiagnosticList diagnostics_impl () const
 
TSDiagnosticList ts_diagnostics_impl () const
 

Private Attributes

std::shared_ptr< YieldStressm_input
 
double m_high_tauc
 

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::Component
void regrid (const std::string &module_name, array::Array &variable, RegriddingFlag flag=NO_REGRID_WITHOUT_REGRID_VARS)
 
- Protected Attributes inherited from pism::YieldStress
array::Scalar2 m_basal_yield_stress
 
std::string m_name
 
- 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

Regional version of yield stress models. Sets high tauc in "no model" areas.

Note: this class has to implement all the virtual methods of Component because it has to forward these calls to the model provided to its constructor.

Definition at line 33 of file RegionalYieldStress.hh.


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