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::ocean::CompleteOceanModel Class Reference

#include <CompleteOceanModel.hh>

+ Inheritance diagram for pism::ocean::CompleteOceanModel:

Public Member Functions

 CompleteOceanModel (IceGrid::ConstPtr g, std::shared_ptr< OceanModel > input)
 
 CompleteOceanModel (IceGrid::ConstPtr g)
 
virtual ~CompleteOceanModel ()
 
- Public Member Functions inherited from pism::ocean::OceanModel
 OceanModel (IceGrid::ConstPtr g, std::shared_ptr< OceanModel > input)
 
 OceanModel (IceGrid::ConstPtr g)
 
virtual ~OceanModel ()
 
void init (const Geometry &geometry)
 
void update (const Geometry &geometry, double t, double dt)
 
const IceModelVec2Sshelf_base_temperature () const
 
const IceModelVec2Sshelf_base_mass_flux () const
 
const IceModelVec2Smelange_back_pressure_fraction () 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 const IceModelVec2Sshelf_base_temperature_impl () const
 
virtual const IceModelVec2Sshelf_base_mass_flux_impl () const
 
- Protected Member Functions inherited from pism::ocean::OceanModel
virtual void init_impl (const Geometry &geometry)
 
virtual void update_impl (const Geometry &geometry, double t, double dt)
 
virtual MaxTimestep max_timestep_impl (double t) const
 
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
 
virtual const IceModelVec2Smelange_back_pressure_fraction_impl () const
 
- Protected Member Functions inherited from pism::Component
virtual void regrid (const std::string &module_name, IceModelVec &variable, RegriddingFlag flag=NO_REGRID_WITHOUT_REGRID_VARS)
 

Protected Attributes

IceModelVec2S::Ptr m_shelf_base_temperature
 
IceModelVec2S::Ptr m_shelf_base_mass_flux
 
- Protected Attributes inherited from pism::ocean::OceanModel
std::shared_ptr< OceanModelm_input_model
 
IceModelVec2S::Ptr m_melange_back_pressure_fraction
 
- 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...
 
- Static Protected Member Functions inherited from pism::ocean::OceanModel
static IceModelVec2S::Ptr allocate_shelf_base_temperature (IceGrid::ConstPtr g)
 
static IceModelVec2S::Ptr allocate_shelf_base_mass_flux (IceGrid::ConstPtr g)
 
static IceModelVec2S::Ptr allocate_melange_back_pressure (IceGrid::ConstPtr g)
 

Detailed Description

Base lass for ocean models with dedicated storage for output fields.

All ocean models have storage for melange back pressure. (All but one set it to zero.)

Definition at line 33 of file CompleteOceanModel.hh.


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