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 | Private Member Functions | Private Attributes | List of all members
pism::surface::ForceThickness Class Reference

#include <ForceThickness.hh>

+ Inheritance diagram for pism::surface::ForceThickness:

Public Member Functions

 ForceThickness (std::shared_ptr< const Grid > g, std::shared_ptr< SurfaceModel > input)
 
virtual ~ForceThickness ()=default
 
- Public Member Functions inherited from pism::surface::SurfaceModel
 SurfaceModel (std::shared_ptr< const Grid > g)
 
 SurfaceModel (std::shared_ptr< const Grid > g, std::shared_ptr< SurfaceModel > input)
 
 SurfaceModel (std::shared_ptr< const Grid > g, std::shared_ptr< atmosphere::AtmosphereModel > atmosphere)
 
virtual ~SurfaceModel ()=default
 
void init (const Geometry &geometry)
 
void update (const Geometry &geometry, double t, double dt)
 
const array::Scalaraccumulation () const
 Returns accumulation. More...
 
const array::Scalarlayer_mass () const
 Returns mass held in the surface layer. More...
 
const array::Scalarlayer_thickness () const
 Returns thickness of the surface layer. Could be used to compute surface elevation as a sum of elevation of the top surface of the ice and surface layer (firn, etc) thickness. More...
 
const array::Scalarliquid_water_fraction () const
 Returns the liquid water fraction of the ice at the top ice surface. More...
 
const array::Scalarmass_flux () const
 
const array::Scalarmelt () const
 Returns melt. More...
 
const array::Scalarrunoff () const
 Returns runoff. More...
 
const array::Scalartemperature () 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...
 

Protected Member Functions

void init_impl (const Geometry &geometry)
 
void update_impl (const Geometry &geometry, double t, double dt)
 
void define_model_state_impl (const File &output) const
 The default (empty implementation). More...
 
void write_model_state_impl (const File &output) const
 The default (empty implementation). More...
 
const array::Scalarmass_flux_impl () const
 
const array::Scalaraccumulation_impl () const
 
const array::Scalarmelt_impl () const
 
const array::Scalarrunoff_impl () const
 
MaxTimestep max_timestep_impl (double t) const
 
- Protected Member Functions inherited from pism::surface::SurfaceModel
virtual const array::Scalarlayer_mass_impl () const
 
virtual const array::Scalarlayer_thickness_impl () const
 
virtual const array::Scalarliquid_water_fraction_impl () const
 
virtual const array::Scalartemperature_impl () const
 
virtual DiagnosticList diagnostics_impl () const
 
virtual TSDiagnosticList ts_diagnostics_impl () const
 
void dummy_accumulation (const array::Scalar &smb, array::Scalar &result)
 
void dummy_melt (const array::Scalar &smb, array::Scalar &result)
 
void dummy_runoff (const array::Scalar &smb, array::Scalar &result)
 
- Protected Member Functions inherited from pism::Component
void regrid (const std::string &module_name, array::Array &variable, RegriddingFlag flag=NO_REGRID_WITHOUT_REGRID_VARS)
 

Private Member Functions

void adjust_mass_flux (double time, const array::Scalar &ice_thickness, const array::CellType &cell_type, array::Scalar &result) const
 

Private Attributes

double m_alpha
 
double m_alpha_ice_free_factor
 
double m_ice_free_thickness_threshold
 
double m_start_time
 
array::Scalar m_target_thickness
 
array::Scalar m_ftt_mask
 
std::shared_ptr< array::Scalarm_mass_flux
 

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...
 
- Static Protected Member Functions inherited from pism::surface::SurfaceModel
static std::shared_ptr< array::Scalarallocate_layer_mass (std::shared_ptr< const Grid > grid)
 
static std::shared_ptr< array::Scalarallocate_layer_thickness (std::shared_ptr< const Grid > grid)
 
static std::shared_ptr< array::Scalarallocate_liquid_water_fraction (std::shared_ptr< const Grid > grid)
 
static std::shared_ptr< array::Scalarallocate_mass_flux (std::shared_ptr< const Grid > grid)
 
static std::shared_ptr< array::Scalarallocate_temperature (std::shared_ptr< const Grid > grid)
 
static std::shared_ptr< array::Scalarallocate_accumulation (std::shared_ptr< const Grid > grid)
 
static std::shared_ptr< array::Scalarallocate_melt (std::shared_ptr< const Grid > grid)
 
static std::shared_ptr< array::Scalarallocate_runoff (std::shared_ptr< const Grid > grid)
 
- Protected Attributes inherited from pism::surface::SurfaceModel
std::shared_ptr< array::Scalarm_liquid_water_fraction
 
std::shared_ptr< array::Scalarm_layer_mass
 
std::shared_ptr< array::Scalarm_layer_thickness
 
std::shared_ptr< array::Scalarm_accumulation
 
std::shared_ptr< array::Scalarm_melt
 
std::shared_ptr< array::Scalarm_runoff
 
std::shared_ptr< SurfaceModelm_input_model
 
std::shared_ptr< atmosphere::AtmosphereModelm_atmosphere
 
- 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 modified surface mass balance which forces ice thickness to a given target by the end of the run.

Definition at line 31 of file ForceThickness.hh.


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