AreaClass Class Reference

This is the class used to store information about the areas used for the current model. More...

#include <areatime.h>

Collaboration diagram for AreaClass:

Public Member Functions
	AreaClass (CommentStream &infile, Keeper *const keeper, const TimeClass *const TimeInfo)
	This is the AreaClass constructor. More...
	~AreaClass ()
	This is the default AreaClass destructor. More...
int	numAreas () const
	This will return the number of areas for the current model. More...
double	getSize (int area) const
	This will return the size of an area. More...
double	getTemperature (int area, int time) const
	This will return the temperature of an area on a timestep. More...
int	getInnerArea (int area) const
	This will return the internal identifier of an area. More...
int	getModelArea (int area) const
	This will return the external identifier of an area. More...
const IntVector &	getAllModelAreas () const
	This will return the the IntVector of all the areas in the current model. More...

Protected Attributes
IntVector	modelAreas
	This is the IntVector of the areas in the current model. More...
FormulaVector	size
	This is the FormulaVector of the size of the areas in the current model. More...
DoubleMatrix	temperature
	This is the DoubleMatrix of the temperature, for each timestep, of the areas in the current model. More...

Detailed Description

This is the class used to store information about the areas used for the current model.

This class keeps an index of the areas in the model. The areas are read in with a numerical identifier, which is stored along with an internal identifier for the areas, which is a simple index starting from 0.

Constructor & Destructor Documentation

AreaClass()

AreaClass::AreaClass	(	CommentStream &	infile,
		Keeper *const	keeper,
		const TimeClass *const	TimeInfo
	)

This is the AreaClass constructor.

Parameters

infile	is the CommentStream to read the area data from
keeper	is the Keeper for the current model
TimeInfo	is the TimeClass for the current model

~AreaClass()

AreaClass::~AreaClass ( )

inline

This is the default AreaClass destructor.

Member Function Documentation

getAllModelAreas()

const IntVector& AreaClass::getAllModelAreas ( ) const

inline

This will return the the IntVector of all the areas in the current model.

Returns

modelAreas

getInnerArea()

int AreaClass::getInnerArea

(

int

area

)

const

This will return the internal identifier of an area.

Parameters

area	is the identifier for the required area

Returns

innerarea

getModelArea()

int AreaClass::getModelArea ( int  area ) const

inline

This will return the external identifier of an area.

Parameters

area	is the identifier for the required area

Returns

outerarea

getSize()

double AreaClass::getSize ( int  area ) const

inline

This will return the size of an area.

Parameters

area	is the identifier for the required area

Returns

size

getTemperature()

double AreaClass::getTemperature ( int  area, int  time  ) const

inline

This will return the temperature of an area on a timestep.

Parameters

area	is the identifier for the required area
time	is the identifier for the required timestep

Returns

temperature

numAreas()

int AreaClass::numAreas ( ) const

inline

This will return the number of areas for the current model.

Returns

number

Member Data Documentation

modelAreas

IntVector AreaClass::modelAreas

protected

This is the IntVector of the areas in the current model.

size

FormulaVector AreaClass::size

protected

This is the FormulaVector of the size of the areas in the current model.

temperature

DoubleMatrix AreaClass::temperature

protected

This is the DoubleMatrix of the temperature, for each timestep, of the areas in the current model.

---

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

• src/include/areatime.h
• src/area.cc