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

The adapter class for Python ocean models. More...

#include <PyOceanModel.hh>

+ Inheritance diagram for pism::ocean::PyOceanModelAdapter:

Public Member Functions

 PyOceanModelAdapter (std::shared_ptr< const Grid > grid, std::shared_ptr< PyOceanModel > implementation)
 
virtual ~PyOceanModelAdapter ()=default
 
- Public Member Functions inherited from pism::ocean::CompleteOceanModel
 CompleteOceanModel (std::shared_ptr< const Grid > g, std::shared_ptr< OceanModel > input)
 
 CompleteOceanModel (std::shared_ptr< const Grid > g)
 
virtual ~CompleteOceanModel ()=default
 
- Public Member Functions inherited from pism::ocean::OceanModel
 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 Geometry &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 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

MaxTimestep max_timestep_impl (double t) const
 
void update_impl (const Geometry &geometry, double my_t, double my_dt)
 
void init_impl (const Geometry &geometry)
 
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...
 

Private Attributes

std::shared_ptr< PyOceanModelm_impl
 

Additional Inherited Members

- Static Public Member Functions inherited from pism::ocean::OceanModel
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 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::ocean::CompleteOceanModel
virtual const array::Scalarshelf_base_temperature_impl () const
 
virtual const array::Scalarshelf_base_mass_flux_impl () const
 
- Protected Member Functions inherited from pism::ocean::OceanModel
virtual DiagnosticList diagnostics_impl () const
 
virtual TSDiagnosticList ts_diagnostics_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 inherited from pism::ocean::CompleteOceanModel
std::shared_ptr< array::Scalarm_shelf_base_temperature
 
std::shared_ptr< array::Scalarm_shelf_base_mass_flux
 
- Protected Attributes inherited from pism::ocean::OceanModel
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 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

The adapter class for Python ocean models.

We need this class because SWIG cannot create a wrapper for the OceanModel class that can be used as a base class for Python classes. (Specifically: it does not support methods that return a reference, e.g. const array::Scalar& shelf_base_mass_flux_impl().)

Definition at line 79 of file PyOceanModel.hh.


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