PSDummy Class Reference

A do-nothing (dummy) surface model. Please avoid using it for real modeling! More...

#include <PISMSurface.hh>

Inheritance diagram for PSDummy:

List of all members.

Public Member Functions
	PSDummy (IceGrid &g, const NCConfigVariable &conf)
virtual void	attach_atmosphere_model (PISMAtmosphereModel *input)
virtual PetscErrorCode	init (PISMVars &)
virtual PetscErrorCode	update (PetscReal t_years, PetscReal dt_years)
	Update a model, if necessary.
virtual PetscErrorCode	ice_surface_mass_flux (IceModelVec2S &)
virtual PetscErrorCode	ice_surface_temperature (IceModelVec2S &)
virtual void	add_vars_to_output (string, set< string > &)
	Adds more variable names to result (to let sub-models respect -o_size or -save_size).
virtual PetscErrorCode	define_variables (set< string >, const NCTool &, nc_type)
virtual PetscErrorCode	write_variables (set< string >, string)
virtual void	get_diagnostics (map< string, PISMDiagnostic * > &)
	Add pointers to available diagnostic quantities to a dictionary.

---

Detailed Description

A do-nothing (dummy) surface model. Please avoid using it for real modeling!

This dummy class is used, for example, when an internal (with respect to IceModel) formula generates the surface mass balance. A specific case is the manufactured solutions used in verification.

Definition at line 61 of file PISMSurface.hh.

---

Constructor & Destructor Documentation

PSDummy	(	IceGrid &	g,
		const NCConfigVariable &	conf
	)		[inline]

Definition at line 63 of file PISMSurface.hh.

---

Member Function Documentation

virtual void add_vars_to_output	(	string	,
		set< string > &
	)		[inline, 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 78 of file PISMSurface.hh.

virtual void attach_atmosphere_model

(

PISMAtmosphereModel *

input

)

[inline, virtual]

Reimplemented from PISMSurfaceModel.

Definition at line 67 of file PISMSurface.hh.

References vnreport::input.

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

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

Reimplemented from PISMSurfaceModel.

Definition at line 79 of file PISMSurface.hh.

virtual void get_diagnostics

(

map< string, PISMDiagnostic * > &

)

[inline, virtual]

Add pointers to available diagnostic quantities to a dictionary.

Reimplemented from PISMSurfaceModel.

Definition at line 85 of file PISMSurface.hh.

virtual PetscErrorCode ice_surface_mass_flux

(

IceModelVec2S &

)

[inline, virtual]

Implements PISMSurfaceModel.

Definition at line 73 of file PISMSurface.hh.

virtual PetscErrorCode ice_surface_temperature

(

IceModelVec2S &

)

[inline, virtual]

Implements PISMSurfaceModel.

Definition at line 76 of file PISMSurface.hh.

virtual PetscErrorCode init

(

PISMVars &

)

[inline, virtual]

Reimplemented from PISMSurfaceModel.

Definition at line 70 of file PISMSurface.hh.

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

Update a model, if necessary.

Implements PISMComponent_TS.

Definition at line 71 of file PISMSurface.hh.

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

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

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

Reimplemented from PISMSurfaceModel.

Definition at line 81 of file PISMSurface.hh.

---

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

• src/coupler/PISMSurface.hh