hydrobricks
Loading...
Searching...
No Matches
ProcessTransform Class Reference
Inheritance diagram for ProcessTransform:
Process ProcessTransformSnowToIce

Public Member Functions

 ProcessTransform (WaterContainer *container)
 
bool IsOk () override
 
int GetConnectionsNb () override
 
double * GetValuePointer (const string &name) override
 
- Public Member Functions inherited from Process
 Process (WaterContainer *container)
 
void Reset ()
 
virtual void SetHydroUnitProperties (HydroUnit *unit, Brick *brick)
 
virtual void SetParameters (const ProcessSettings &processSettings)
 
virtual void AttachForcing (Forcing *)
 
void AttachFluxOut (Flux *flux)
 
vector< Flux * > GetOutputFluxes ()
 
int GetOutputFluxesNb ()
 
virtual bool ToAtmosphere ()
 
virtual bool NeedsTargetBrickLinking ()
 
virtual vecDouble GetChangeRates ()
 
virtual void StoreInOutgoingFlux (double *rate, int index)
 
void ApplyChange (int connectionIndex, double rate, double timeStepInDays)
 
virtual void Finalize ()
 
virtual vecDoublePt GetStateVariables ()
 
string GetName ()
 
void SetName (const string &name)
 
WaterContainerGetWaterContainer ()
 
virtual void SetTargetBrick (Brick *)
 

Static Public Member Functions

static void RegisterProcessParametersAndForcing (SettingsModel *modelSettings)
 
- Static Public Member Functions inherited from Process
static ProcessFactory (const ProcessSettings &processSettings, Brick *brick)
 
static bool RegisterParametersAndForcing (SettingsModel *modelSettings, const string &processType)
 
static bool HasParameter (const ProcessSettings &processSettings, const string &name)
 
static float * GetParameterValuePointer (const ProcessSettings &processSettings, const string &name)
 

Additional Inherited Members

- Protected Member Functions inherited from Process
double GetSumChangeRatesOtherProcesses ()
 
virtual vecDouble GetRates ()=0
 
- Protected Attributes inherited from Process
string m_name
 
WaterContainerm_container
 
vector< Flux * > m_outputs
 

Member Function Documentation

◆ GetConnectionsNb()

int ProcessTransform::GetConnectionsNb ( )
overridevirtual

Get the number of connections to the process.

Returns
number of connections to the process.

Implements Process.

◆ GetValuePointer()

double * ProcessTransform::GetValuePointer ( const string & name)
overridevirtual

Get the value pointer for a given element.

Parameters
namename of the element to get.
Returns
pointer to the value of the given element.

Reimplemented from Process.

◆ IsOk()

bool ProcessTransform::IsOk ( )
overridevirtual

Check that everything is correctly defined.

Returns
true is everything is correctly defined.

Implements Process.

◆ RegisterProcessParametersAndForcing()

void ProcessTransform::RegisterProcessParametersAndForcing ( SettingsModel * modelSettings)
static

Register the process parameters and forcing in the settings model.

Parameters
modelSettingsThe settings model to register the parameters in.

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