POConstant Class Reference

A class implementing a constant (in terms of the ocean inputs) ocean model. Uses configuration parameters for the sea level elevation and sub-shelf heat flux. More...

#include <PISMOcean.hh>

Inheritance diagram for POConstant:

List of all members.

Public Member Functions
	POConstant (IceGrid &g, const NCConfigVariable &conf)
virtual	~POConstant ()
virtual PetscErrorCode	init (PISMVars &vars)
virtual PetscErrorCode	update (PetscReal t_years, PetscReal dt_years)
	Update a model, if necessary.
virtual PetscErrorCode	sea_level_elevation (PetscReal &result)
virtual PetscErrorCode	shelf_base_temperature (IceModelVec2S &result)
virtual PetscErrorCode	shelf_base_mass_flux (IceModelVec2S &result)
	Computes mass flux in ice-equivalent m s-1, from assumption that basal heat flux rate converts to mass flux.
virtual void	add_vars_to_output (string keyword, set< string > &result)
	Adds more variable names to result (to let sub-models respect -o_size or -save_size).
virtual PetscErrorCode	define_variables (set< string > vars, const NCTool &nc, nc_type nctype)
virtual PetscErrorCode	write_variables (set< string > vars, string filename)
Protected Attributes
IceModelVec2S *	ice_thickness
NCSpatialVariable	shelfbmassflux
NCSpatialVariable	shelfbtemp

---

Detailed Description

A class implementing a constant (in terms of the ocean inputs) ocean model. Uses configuration parameters for the sea level elevation and sub-shelf heat flux.

Definition at line 46 of file PISMOcean.hh.

---

Constructor & Destructor Documentation

POConstant	(	IceGrid &	g,
		const NCConfigVariable &	conf
	)

Definition at line 24 of file PISMOcean.cc.

References shelfbmassflux, and shelfbtemp.

virtual ~POConstant

(

)

[inline, virtual]

Definition at line 49 of file PISMOcean.hh.

---

Member Function Documentation

void add_vars_to_output	(	string	,
		set< string > &
	)		[virtual]

Adds more variable names to result (to let sub-models respect -o_size or -save_size).

Keyword can be one of "small", "medium" or "big".

Reimplemented from PISMComponent.

Definition at line 96 of file PISMOcean.cc.

PetscErrorCode define_variables	(	set< string >	,
		const NCTool &	,
		nc_type
	)		[virtual]

Defines requested couplings fields to file and/or asks an attached model to do so.

Reimplemented from PISMComponent.

Definition at line 103 of file PISMOcean.cc.

References shelfbmassflux, and shelfbtemp.

PetscErrorCode init

(

PISMVars &

vars

)

[virtual]

Implements PISMComponent.

Definition at line 41 of file PISMOcean.cc.

References PISMComponent::config, PISMComponent::grid, and ice_thickness.

PetscErrorCode sea_level_elevation

(

PetscReal &

result

)

[virtual]

Implements PISMOceanModel.

Definition at line 54 of file PISMOcean.cc.

References PISMOceanModel::sea_level.

PetscErrorCode shelf_base_mass_flux

(

IceModelVec2S &

result

)

[virtual]

Computes mass flux in ice-equivalent m s-1, from assumption that basal heat flux rate converts to mass flux.

Implements PISMOceanModel.

Definition at line 84 of file PISMOcean.cc.

References PISMComponent::config, L, and rho.

Referenced by write_variables().

PetscErrorCode shelf_base_temperature

(

IceModelVec2S &

result

)

[virtual]

Implements PISMOceanModel.

Definition at line 59 of file PISMOcean.cc.

References PISMComponent::config, PISMComponent::grid, exactV::H(), and ice_thickness.

Referenced by write_variables().

virtual PetscErrorCode update	(	PetscReal	,
		PetscReal
	)		[inline, virtual]

Update a model, if necessary.

Implements PISMComponent_TS.

Definition at line 52 of file PISMOcean.hh.

References PISMComponent_TS::dt, and PISMComponent_TS::t.

PetscErrorCode write_variables	(	set< string >	,
		string
	)		[virtual]

Writes requested couplings fields to file and/or asks an attached model to do so.

Reimplemented from PISMComponent.

Definition at line 119 of file PISMOcean.cc.

References PISMComponent::grid, shelf_base_mass_flux(), shelf_base_temperature(), shelfbmassflux, and shelfbtemp.

---

Member Data Documentation

IceModelVec2S* ice_thickness [protected]

Definition at line 64 of file PISMOcean.hh.

Referenced by init(), and shelf_base_temperature().

NCSpatialVariable shelfbmassflux [protected]

Definition at line 65 of file PISMOcean.hh.

Referenced by define_variables(), POConstant(), and write_variables().

NCSpatialVariable shelfbtemp [protected]

Definition at line 65 of file PISMOcean.hh.

Referenced by define_variables(), POConstant(), and write_variables().

---

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

• src/coupler/PISMOcean.hh
• src/coupler/PISMOcean.cc