PeatlandAfterCBMModule Class Reference

#include <peatlandaftercbmmodule.h>

Inheritance diagram for PeatlandAfterCBMModule:

Collaboration diagram for PeatlandAfterCBMModule:

Public Member Functions
	PeatlandAfterCBMModule ()
virtual	~PeatlandAfterCBMModule ()
void	configure (const DynamicObject &config) override
void	subscribe (NotificationCenter &notificationCenter) override
void	doLocalDomainInit () override
void	doTimingStep () override
Public Member Functions inherited from CBMModuleBase
virtual	~CBMModuleBase ()=default
void	onSystemInit () override
void	onSystemShutdown () override
void	onLocalDomainInit () override
void	onLocalDomainShutdown () override
void	onLocalDomainProcessingUnitInit () override
void	onLocalDomainProcessingUnitShutdown () override
void	onPreTimingSequence () override
void	onTimingInit () override
void	onTimingPrePostInit () override
void	onTimingPostInit () override
void	onTimingPostInit2 () override
void	onTimingShutdown () override
void	onTimingStep () override
void	onTimingPreEndStep () override
void	onTimingEndStep () override
void	onTimingPostStep () override
void	onOutputStep () override
void	onPrePostDisturbanceEvent () override
void	onPostDisturbanceEvent () override
void	onPostDisturbanceEvent2 () override
void	onError (std::string msg) override
void	onDisturbanceEvent (DynamicVar e) override
void	onPostNotification (short preMessageSignal) override
virtual void	doSystemInit ()
virtual void	doSystemShutdown ()
virtual void	doLocalDomainShutdown ()
virtual void	doLocalDomainProcessingUnitInit ()
virtual void	doLocalDomainProcessingUnitShutdown ()
virtual void	doPreTimingSequence ()
virtual void	doTimingInit ()
virtual void	doTimingPrePostInit ()
virtual void	doTimingPostInit ()
virtual void	doTimingPostInit2 ()
virtual void	doTimingShutdown ()
virtual void	doTimingPreEndStep ()
virtual void	doTimingEndStep ()
virtual void	doTimingPostStep ()
virtual void	doOutputStep ()
virtual void	doError (std::string msg)
virtual void	doDisturbanceEvent (DynamicVar)
virtual void	doPrePostDisturbanceEvent ()
virtual void	doPostDisturbanceEvent ()
virtual void	doPostDisturbanceEvent2 ()
virtual void	doPostNotification (short preMessageSignal)

Private Member Functions
void	transferCBMPoolToPeatland ()

Private Attributes
const flint::IPool *	_acrotelm_o
const flint::IPool *	_catotelm_a
const flint::IPool *	_atmosphere
const flint::IPool *	_softwoodFoliage
const flint::IPool *	_hardwoodFoliage
const flint::IPool *	_softwoodOther
const flint::IPool *	_hardwoodOther
const flint::IPool *	_softwoodFineRoots
const flint::IPool *	_hardwoodFineRoots
const flint::IPool *	_woodyFoliageDead
const flint::IPool *	_woodyStemsBranchesDead
const flint::IPool *	_woodyRootsDead

Constructor & Destructor Documentation

PeatlandAfterCBMModule()

PeatlandAfterCBMModule

(

)

~PeatlandAfterCBMModule()

virtual ~PeatlandAfterCBMModule ( )

virtual

Member Function Documentation

configure()

void configure ( const DynamicObject &  config )

override

Configuration function

Returns

void

doLocalDomainInit()

void doLocalDomainInit ( )

overridevirtual

Assign pools PeatlandAfterCBMModule._acrotelm_o, PeatlandAfterCBMModule._catotelm_a, PeatlandAfterCBMModule._atmosphere,
PeatlandAfterCBMModule._softwoodFoliage, PeatlandAfterCBMModule._hardwoodFoliage
, PeatlandAfterCBMModule._softwoodOther, PeatlandAfterCBMModule._hardwoodOther, PeatlandAfterCBMModule._softwoodFineRoots,
PeatlandAfterCBMModule._hardwoodFineRoots, PeatlandAfterCBMModule._woodyFoliageDead, PeatlandAfterCBMModule._woodyStemsBranchesDead,
PeatlandAfterCBMModule._woodyRootsDead from _landUnitData

Returns

void

Reimplemented from CBMModuleBase.

doTimingStep()

void doTimingStep ( )

overridevirtual

Perform on every timing step

Return if the value of the variable "spinup_moss_only" in _landUnitData is true,
else, invoke PeatlandAfterCBMModule.transferCBMPoolToPeatland()

Returns

void

Reimplemented from CBMModuleBase.

subscribe()

void subscribe ( NotificationCenter &  notificationCenter )

override

Subscribe to signals TimingStep and LocalDomainInit

Returns

void

transferCBMPoolToPeatland()

void transferCBMPoolToPeatland ( )

private

Transfer CBM pools to Peatland pools

If the value of the variable "peatlandId" in _landUnitData is 7, 8 or 9, i.e
if it is of forestry type, then there is a transfer from CBM to peatland pools

Returns

void

Member Data Documentation

_acrotelm_o

const flint::IPool* _acrotelm_o

private

_atmosphere

const flint::IPool* _atmosphere

private

_catotelm_a

const flint::IPool* _catotelm_a

private

_hardwoodFineRoots

const flint::IPool* _hardwoodFineRoots

private

_hardwoodFoliage

const flint::IPool* _hardwoodFoliage

private

_hardwoodOther

const flint::IPool* _hardwoodOther

private

_softwoodFineRoots

const flint::IPool* _softwoodFineRoots

private

_softwoodFoliage

const flint::IPool* _softwoodFoliage

private

_softwoodOther

const flint::IPool* _softwoodOther

private

_woodyFoliageDead

const flint::IPool* _woodyFoliageDead

private

_woodyRootsDead

const flint::IPool* _woodyRootsDead

private

_woodyStemsBranchesDead

const flint::IPool* _woodyStemsBranchesDead

private

---

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

• /home/runner/work/moja.canada/moja.canada/Source/moja.modules.cbm/include/moja/modules/cbm/peatlandaftercbmmodule.h
• /home/runner/work/moja.canada/moja.canada/Source/moja.modules.cbm/src/peatlandaftercbmmodule.cpp