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 | Protected Member Functions | Protected Attributes | List of all members
pism::PrescribedRetreat Class Reference

#include <PrescribedRetreat.hh>

+ Inheritance diagram for pism::PrescribedRetreat:

Public Member Functions

 PrescribedRetreat (std::shared_ptr< const Grid > grid)
 
virtual ~PrescribedRetreat ()=default
 
void init ()
 
void update (double t, double dt, array::Scalar &ice_thickness, array::Scalar &ice_area_specific_volume)
 
- 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...
 

Protected Member Functions

MaxTimestep max_timestep_impl (double t) const
 
- Protected Member Functions inherited from pism::Component
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 regrid (const std::string &module_name, array::Array &variable, RegriddingFlag flag=NO_REGRID_WITHOUT_REGRID_VARS)
 

Protected Attributes

std::shared_ptr< array::Forcingm_retreat_mask
 
- 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...
 

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

Implementation of the ISMIP6 parameterized retreat.

Reads a space-and-time-dependent ice extent mask from a file. This mask contains values from 0 to 1. Zero corresponds to "ice-free", one to "ice covered", values in between correspond to cells that are partially covered.

Each time update() is called, this module gets the mask corresponding to the provided model time. Then, for each grid cell, if the mask is zero, ice is removed (updating ice thickness and area specific volume). If the mask is between 0 and 1, remove the corresponding fraction of ice volume in this cell. If the mask is 1 ice thickness is not modified.

Definition at line 40 of file PrescribedRetreat.hh.


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