PISM, A Parallel Ice Sheet Model 2.3.0-79cae578d committed by Constantine Khrulev on 2026-03-22
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
pism::ocean::OceanModel Class Reference

A very rudimentary PISM ocean model. More...

#include <OceanModel.hh>

+ Inheritance diagram for pism::ocean::OceanModel:

Public Member Functions

 OceanModel (std::shared_ptr< const Grid > g, std::shared_ptr< OceanModel > input)
 
 OceanModel (std::shared_ptr< const Grid > g)
 
virtual ~OceanModel ()=default
 
void init (const Geometry &geometry)
 
void update (const Inputs &geometry, double t, double dt)
 
const array::Scalarshelf_base_temperature () const
 
const array::Scalarshelf_base_mass_flux () const
 
const array::Scalaraverage_water_column_pressure () const
 
- Public Member Functions inherited from pism::Component
 Component (std::shared_ptr< const Grid > grid)
 
virtual ~Component ()=default
 
DiagnosticList spatial_diagnostics () const
 
TSDiagnosticList scalar_diagnostics () const
 
std::shared_ptr< const Gridgrid () const
 
const Timetime () const
 
const Profilingprofiling () const
 
void write_state (const OutputFile &output) const
 Write model state variables to an output file.
 
std::set< VariableMetadatastate () const
 
MaxTimestep max_timestep (double t) const
 Reports the maximum time-step the model can take at time t.
 

Static Public Member Functions

static std::shared_ptr< array::Scalarallocate_shelf_base_temperature (std::shared_ptr< const Grid > g)
 
static std::shared_ptr< array::Scalarallocate_shelf_base_mass_flux (std::shared_ptr< const Grid > g)
 
static std::shared_ptr< array::Scalarallocate_water_column_pressure (std::shared_ptr< const Grid > g)
 

Protected Member Functions

virtual void init_impl (const Geometry &geometry)
 
virtual void update_impl (const Inputs &inputs, double t, double dt)
 
virtual MaxTimestep max_timestep_impl (double t) const
 
virtual std::set< VariableMetadatastate_impl () const
 
virtual void write_state_impl (const OutputFile &output) const
 The default (empty implementation).
 
virtual DiagnosticList spatial_diagnostics_impl () const
 
virtual TSDiagnosticList scalar_diagnostics_impl () const
 
virtual const array::Scalarshelf_base_temperature_impl () const
 
virtual const array::Scalarshelf_base_mass_flux_impl () const
 
virtual const array::Scalaraverage_water_column_pressure_impl () const
 
- 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

std::shared_ptr< OceanModelm_input_model
 
std::shared_ptr< array::Scalarm_water_column_pressure
 
- Protected Attributes inherited from pism::Component
const std::shared_ptr< const Gridm_grid
 grid used by this component
 
std::shared_ptr< const Configm_config
 configuration database used by this component
 
const units::System::Ptr m_sys
 unit system used by this component
 
std::shared_ptr< const Loggerm_log
 logger (for easy access)
 

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

A very rudimentary PISM ocean model.

Definition at line 38 of file OceanModel.hh.


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