hydrobricks
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
Splitter Class Referenceabstract
Inheritance diagram for Splitter:
SplitterMultiFluxes SplitterRain SplitterSnowRain

Public Member Functions

virtual bool IsOk ()=0
 
virtual void SetParameters (const SplitterSettings &splitterSettings)=0
 
float * GetParameterValuePointer (const SplitterSettings &splitterSettings, const string &name)
 
virtual void AttachForcing (Forcing *)
 
void AttachFluxIn (Flux *flux)
 
void AttachFluxOut (Flux *flux)
 
virtual double * GetValuePointer (const string &name)=0
 
virtual void Compute ()=0
 
string GetName ()
 
void SetName (const string &name)
 

Static Public Member Functions

static Splitter * Factory (const SplitterSettings &splitterSettings)
 

Protected Attributes

string m_name
 
vector< Flux * > m_inputs
 
vector< Flux * > m_outputs
 

Member Function Documentation

◆ AttachFluxIn()

void Splitter::AttachFluxIn ( Flux *  flux)
inline

Attach incoming flux.

Parameters
fluxincoming flux

◆ AttachFluxOut()

void Splitter::AttachFluxOut ( Flux *  flux)
inline

Attach outgoing flux.

Parameters
fluxoutgoing flux

◆ IsOk()

virtual bool Splitter::IsOk ( )
pure virtual

Check that everything is correctly defined.

Returns
true is everything is correctly defined.

Implemented in SplitterMultiFluxes, SplitterRain, and SplitterSnowRain.

◆ SetParameters()

virtual void Splitter::SetParameters ( const SplitterSettings &  splitterSettings)
pure virtual

Assign the parameters to the splitter.

Parameters
splitterSettingssettings of the splitter containing the parameters.

Implemented in SplitterMultiFluxes, SplitterRain, and SplitterSnowRain.

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