IceModelVec2Stag Class Reference

A class for storing and accessing internal staggered-grid 2D fields. Uses dof=2 storage. Does not support input and output. This class is identical to IceModelVec2V, except that components are not called u and v (to avoid confusion). More...

#include <iceModelVec.hh>

Inheritance diagram for IceModelVec2Stag:

[legend]

List of all members.

Public Member Functions
	IceModelVec2Stag ()
	IceModelVec2Stag (const IceModelVec2S &other)
virtual PetscErrorCode	create (IceGrid &my_grid, const char my_name[], bool local, int width=1)
virtual PetscErrorCode	get_array (PetscScalar ***&a)
virtual PetscErrorCode	begin_access ()
	Checks if an IceModelVec is allocated and calls DAVecGetArray.
virtual PetscErrorCode	end_access ()
	Checks if an IceModelVec is allocated and calls DAVecRestoreArray.
virtual PetscScalar &	operator() (int i, int j, int k)

---

Detailed Description

A class for storing and accessing internal staggered-grid 2D fields. Uses dof=2 storage. Does not support input and output. This class is identical to IceModelVec2V, except that components are not called u and v (to avoid confusion).

Definition at line 171 of file iceModelVec.hh.

---

Constructor & Destructor Documentation

IceModelVec2Stag

(

)

Definition at line 173 of file iceModelVec.hh.

References IceModelVec.dof, and IceModelVec.vars.

IceModelVec2Stag

(

const IceModelVec2S &

other

)

Definition at line 174 of file iceModelVec.hh.

---

Member Function Documentation

PetscErrorCode begin_access

(

)

[virtual]

Checks if an IceModelVec is allocated and calls DAVecGetArray.

Reimplemented from IceModelVec.

Definition at line 475 of file iceModelVec2.cc.

References IceModelVec.access_counter, IceModelVec.array, IceModelVec.checkAllocated(), IceModelVec.da, and IceModelVec.v.

Referenced by IceModel.assembleSSARhs(), IceModel.broadcastSSAVelocity(), IceModel.computeMaxDiffusivity(), get_array(), IceModel.massContExplicitStep(), IceModel.readShelfStreamBCFromFile(), IceExactSSAModel.setInitStateAndBoundaryVelsI(), IceExactSSAModel.setInitStateJ(), IceExactSSAModel.setInitStateM(), IceModel.velocities2DSIAToRegular(), and IceModel.velocitySIAStaggered().

PetscErrorCode create	(	IceGrid &	my_grid,
		const char	my_name[],
		bool	local,
		int	width = 1
	)			[virtual]

Definition at line 463 of file iceModelVec2.cc.

References IceModelVec.dof, GRID_2D, IceModelVec.name, and IceModelVec.vars.

Referenced by IceModel.createVecs().

PetscErrorCode end_access

(

)

[virtual]

Checks if an IceModelVec is allocated and calls DAVecRestoreArray.

Reimplemented from IceModelVec.

Definition at line 494 of file iceModelVec2.cc.

References IceModelVec.access_counter, IceModelVec.array, IceModelVec.checkAllocated(), IceModelVec.da, and IceModelVec.v.

Referenced by IceModel.assembleSSARhs(), IceModel.broadcastSSAVelocity(), IceModel.computeMaxDiffusivity(), IceModel.massContExplicitStep(), IceModel.readShelfStreamBCFromFile(), IceExactSSAModel.setInitStateAndBoundaryVelsI(), IceExactSSAModel.setInitStateJ(), IceExactSSAModel.setInitStateM(), IceModel.velocities2DSIAToRegular(), and IceModel.velocitySIAStaggered().

PetscErrorCode get_array

(

PetscScalar ***&

a

)

[virtual]

Definition at line 518 of file iceModelVec2.cc.

References IceModelVec.array, and begin_access().

PetscScalar & operator()	(	int	i,
		int	j,
		int	k
	)			[virtual]

Definition at line 514 of file iceModelVec2.cc.

References IceModelVec.array.

---

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

• stable0.3/src/base/iceModelVec.hh
• stable0.3/src/base/iceModelVec2.cc