PISMAtmosphereModel Class Reference

A purely virtual class defining the interface of a PISM Atmosphere Model. More...

#include <PISMAtmosphere.hh>

Inheritance diagram for PISMAtmosphereModel:

List of all members.

Public Member Functions
	PISMAtmosphereModel (IceGrid &g, const NCConfigVariable &conf)
virtual PetscErrorCode	mean_precip (IceModelVec2S &result)=0
	Sets result to the mean precipitation, in m/s ice equivalent.
virtual PetscErrorCode	mean_annual_temp (IceModelVec2S &result)=0
	Sets result to the mean annual near-surface air temperature, in degrees Kelvin.
virtual PetscErrorCode	begin_pointwise_access ()=0
virtual PetscErrorCode	end_pointwise_access ()=0
virtual PetscErrorCode	temp_time_series (int i, int j, int N, PetscReal *ts, PetscReal *values)=0
	Sets a pre-allocated N-element array "values" to the time-series of near-surface air temperature (degrees Kelvin) at the point i,j on the grid. Times (in years) are specified in ts. NB! Has to be surrounded by begin_pointwise_access() and end_pointwise_access()
virtual PetscErrorCode	temp_snapshot (IceModelVec2S &result)=0
	Sets result to a snapshot of temperature for the time t_years. (For disgnostic purposes.)

---

Detailed Description

A purely virtual class defining the interface of a PISM Atmosphere Model.

Definition at line 33 of file PISMAtmosphere.hh.

---

Constructor & Destructor Documentation

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

Definition at line 35 of file PISMAtmosphere.hh.

---

Member Function Documentation

virtual PetscErrorCode begin_pointwise_access

(

)

[pure virtual]

Implemented in PADirectForcing, PALapseRates, PAConstant, PAYearlyCycle, PAModifier, and PAForcing.

Referenced by PAModifier::begin_pointwise_access(), PALapseRates::begin_pointwise_access(), PAForcing::begin_pointwise_access(), and PSTemperatureIndex::update_internal().

virtual PetscErrorCode end_pointwise_access

(

)

[pure virtual]

Implemented in PADirectForcing, PALapseRates, PAConstant, PAYearlyCycle, PAModifier, and PAForcing.

Referenced by PAModifier::end_pointwise_access(), PALapseRates::end_pointwise_access(), PAForcing::end_pointwise_access(), and PSTemperatureIndex::update_internal().

virtual PetscErrorCode mean_annual_temp

(

IceModelVec2S &

result

)

[pure virtual]

Sets result to the mean annual near-surface air temperature, in degrees Kelvin.

Implemented in PADirectForcing, PALapseRates, PAConstant, PAYearlyCycle, PAModifier, PAForcing, and PAdTforcing.

Referenced by PSTemperatureIndex::ice_surface_temperature(), PSSimple::ice_surface_temperature(), PAdTforcing::mean_annual_temp(), PAModifier::mean_annual_temp(), PALapseRates::mean_annual_temp(), and PAForcing::mean_annual_temp().

virtual PetscErrorCode mean_precip

(

IceModelVec2S &

result

)

[pure virtual]

Sets result to the mean precipitation, in m/s ice equivalent.

Implemented in PADirectForcing, PALapseRates, PAConstant, PAYearlyCycle, PA_SeaRISE_Greenland, PAModifier, and PAForcing.

Referenced by PSSimple::ice_surface_mass_flux(), PAModifier::mean_precip(), PALapseRates::mean_precip(), PAForcing::mean_precip(), and PSTemperatureIndex::update_internal().

virtual PetscErrorCode temp_snapshot

(

IceModelVec2S &

result

)

[pure virtual]

Sets result to a snapshot of temperature for the time t_years. (For disgnostic purposes.)

Implemented in PADirectForcing, PALapseRates, PAConstant, PAYearlyCycle, PAModifier, PAForcing, and PAdTforcing.

Referenced by PAdTforcing::temp_snapshot(), PAModifier::temp_snapshot(), PALapseRates::temp_snapshot(), and PAForcing::temp_snapshot().

virtual PetscErrorCode temp_time_series	(	int	i,
		int	j,
		int	N,
		PetscReal *	ts,
		PetscReal *	values
	)		[pure virtual]

Sets a pre-allocated N-element array "values" to the time-series of near-surface air temperature (degrees Kelvin) at the point i,j on the grid. Times (in years) are specified in ts. NB! Has to be surrounded by begin_pointwise_access() and end_pointwise_access()

Implemented in PADirectForcing, PALapseRates, PAConstant, PAYearlyCycle, PAModifier, PAForcing, and PAdTforcing.

Referenced by PAdTforcing::temp_time_series(), PAModifier::temp_time_series(), PALapseRates::temp_time_series(), PAForcing::temp_time_series(), and PSTemperatureIndex::update_internal().

---

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

• src/coupler/PISMAtmosphere.hh