SurfaceComponent Class Reference

Inheritance diagram for SurfaceComponent:

Public Member Functions
bool	CanHaveAreaFraction () const override
double	GetAreaFraction () const
void	SetAreaFraction (double value)
double	GetParentAreaFraction () const
bool	IsNull () const override
bool	HasParent () const
LandCover *	GetParent () const
virtual void	SetParent (LandCover *parent)
Public Member Functions inherited from Brick
virtual void	SetParameters (const BrickSettings &brickSettings)
virtual void	AttachFluxIn (Flux *flux)
void	AddProcess (std::unique_ptr< Process > process)
virtual void	Reset ()
virtual void	SaveAsInitialState ()
virtual bool	IsValid (bool checkProcesses=true) const
virtual void	Validate () const
bool	NeedsSolver () const
BrickCategory	GetCategory () const
virtual bool	IsLandCover () const
bool	HasProcesses () const
bool	HasHydroUnit () const
virtual void	Finalize ()
virtual void	SetInitialState (double value, ContentType type)
virtual double	GetContent (ContentType type) const
virtual void	UpdateContent (double value, ContentType type)
virtual void	UpdateContentFromInputs ()
virtual void	ApplyConstraints (double timeStep)
WaterContainer *	GetWaterContainer () const
size_t	GetProcessCount () const
Process *	GetProcess (size_t index) const
const string &	GetName () const
void	SetName (const string &name)
HydroUnit *	GetHydroUnit () const
void	SetHydroUnit (HydroUnit *hydroUnit)
virtual vecDoublePt	GetDynamicContentChanges ()
vecDoublePt	GetStateVariableChangesFromProcesses ()
int	GetProcessConnectionCount () const
double *	GetBaseValuePointer (const string &name)
virtual double *	GetValuePointer (const string &name)

Protected Attributes
LandCover *	_parent
double	_areaFraction
Protected Attributes inherited from Brick
string	_name
bool	_needsSolver
BrickCategory	_category
std::unique_ptr< WaterContainer >	_water
std::vector< std::unique_ptr< Process > >	_processes
HydroUnit *	_hydroUnit

Additional Inherited Members
Static Public Member Functions inherited from Brick
static Brick *	Factory (const BrickSettings &brickSettings)
static Brick *	Factory (BrickType type)
static bool	HasParameter (const BrickSettings &brickSettings, const string &name)
static const float *	GetParameterValuePointer (const BrickSettings &brickSettings, const string &name)

Member Function Documentation

CanHaveAreaFraction()

bool SurfaceComponent::CanHaveAreaFraction ( ) const

inlinenodiscardoverridevirtual

Check if the brick can have an area fraction.

Returns

true if the brick can have an area fraction.

Reimplemented from Brick.

GetAreaFraction()

double SurfaceComponent::GetAreaFraction ( ) const

inline

Gets the area fraction of this component.

Returns

The area fraction of this component.

GetParent()

LandCover * SurfaceComponent::GetParent ( ) const

inline

Get the parent land cover of this component.

Returns

The parent land cover of this component.

GetParentAreaFraction()

double SurfaceComponent::GetParentAreaFraction

(

)

const

Gets the area fraction of the parent land cover of this component.

Returns

The area fraction of the parent land cover.

HasParent()

bool SurfaceComponent::HasParent ( ) const

inlinenodiscard

Check if the component has a parent land cover.

Returns

true if the component has a parent land cover.

IsNull()

bool SurfaceComponent::IsNull ( ) const

nodiscardoverridevirtual

Check if the brick is null (e.g., if the area fraction is null).

Returns

true if the brick is null.

Reimplemented from Brick.

SetAreaFraction()

void SurfaceComponent::SetAreaFraction

(

double

value

)

Sets the area fraction of this component.

Parameters

value

The area fraction of this component.

SetParent()

virtual void SurfaceComponent::SetParent ( LandCover * parent )

inlinevirtual

Sets the parent land cover of this component.

Parameters

parent

The parent land cover of this component.

---

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

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