Brick Class Reference

Inheritance diagram for Brick:

Public Member Functions
virtual void	SetParameters (const BrickSettings &brickSettings)
virtual void	AttachFluxIn (Flux *flux)
void	AddProcess (Process *process)
virtual void	Reset ()
virtual void	SaveAsInitialState ()
virtual bool	IsOk ()
bool	NeedsSolver () const
virtual bool	CanHaveAreaFraction ()
virtual bool	IsSnowpack ()
virtual bool	IsGlacier ()
virtual bool	IsLandCover ()
virtual bool	IsNull ()
virtual void	Finalize ()
virtual void	UpdateContentFromInputs ()
virtual void	ApplyConstraints (double timeStep)
WaterContainer *	GetWaterContainer ()
Process *	GetProcess (int index)
vector< Process * > &	GetProcesses ()
string	GetName ()
void	SetName (const string &name)
virtual vecDoublePt	GetDynamicContentChanges ()
vecDoublePt	GetStateVariableChangesFromProcesses ()
int	GetProcessesConnectionsNb ()
double *	GetBaseValuePointer (const string &name)
virtual double *	GetValuePointer (const string &name)

Static Public Member Functions
static Brick *	Factory (const BrickSettings &brickSettings)
static bool	HasParameter (const BrickSettings &brickSettings, const string &name)
static float *	GetParameterValuePointer (const BrickSettings &brickSettings, const string &name)

Protected Attributes
string	m_name
bool	m_needsSolver
WaterContainer *	m_container
vector< Process * >	m_processes

Member Function Documentation

AttachFluxIn()

void Brick::AttachFluxIn ( Flux * flux )

virtual

Attach incoming flux.

Parameters

flux	incoming flux

Reimplemented in Glacier, and Snowpack.

Factory()

Brick * Brick::Factory ( const BrickSettings & brickSettings )

static

Factory method to create a brick.

Parameters

brickSettings

settings of the brick.

Returns

the created brick.

GetDynamicContentChanges()

vecDoublePt Brick::GetDynamicContentChanges ( )

virtual

Get pointers to the state variables.

Returns

vector of pointers to the state variables.

Reimplemented in Glacier, and Snowpack.

GetParameterValuePointer()

float * Brick::GetParameterValuePointer ( const BrickSettings & brickSettings, const string & name )

static

Get the pointer to the parameter value.

Parameters

brickSettings	settings of the brick containing the parameters.
name	name of the parameter.

Returns

pointer to the parameter value.

HasParameter()

bool Brick::HasParameter ( const BrickSettings & brickSettings, const string & name )

static

Check if the brick has a parameter with the provided name.

Parameters

brickSettings	settings of the brick containing the parameters.
name	name of the parameter to check.

Returns

true if the brick has a parameter with the provided name.

IsOk()

bool Brick::IsOk ( )

virtual

Check that everything is correctly defined.

Returns

true is everything is correctly defined.

Reimplemented in Glacier, and Snowpack.

NeedsSolver()

bool Brick::NeedsSolver ( ) const

inline

Define if the brick needs to be handled by the solver.

Returns

true if the brick needs to be handled by the solver.

SetParameters()

void Brick::SetParameters ( const BrickSettings & brickSettings )

virtual

Assign the parameters to the brick element.

Parameters

brickSettings

settings of the brick containing the parameters.

Reimplemented in GenericLandCover, Glacier, Snowpack, Storage, Urban, and Vegetation.

---

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

• /github/workspace/core/src/bricks/Brick.h
• /github/workspace/core/src/bricks/Brick.cpp