GCBM
Classes | Typedefs | Enumerations | Functions | Variables
moja::modules::cbm Namespace Reference

Classes

class  AboveGroundBiomassCarbonIncrement
 
class  AgeAreaRecord
 
class  AgeClassHelper
 
class  AgeClassRecord
 
class  CarbonRecoveryRule
 
class  CBMAgeIndicators
 
class  CBMAggregatorCsvWriter
 
class  CBMAggregatorLandUnitData
 
class  CBMAggregatorLibPQXXWriter
 
class  CBMAggregatorPostgreSQLWriter
 
class  CBMAggregatorSQLiteWriter
 
class  CBMBuildLandUnitModule
 
class  CBMDecayModule
 
class  CBMDistEventRef
 
class  CBMDistEventTransfer
 
class  CBMDisturbanceEventModule
 
class  CBMDisturbanceListener
 
class  CBMFlatAggregatorLandUnitData
 
class  CBMFlatFile
 
class  CBMLandClassTransitionModule
 
class  CBMLandUnitDataTransform
 
class  CBMModuleBase
 
class  CBMPartitioningModule
 
class  CBMPeatlandSpinupOutput
 
class  CBMSequencer
 
class  CBMSpinupDisturbanceModule
 
class  CBMSpinupSequencer
 
class  CBMTransitionRulesModule
 
class  ClassifierSetRecord
 
class  ComponentBiomassCarbonCurve
 
class  CompositeDisturbanceSubCondition
 
class  DateRecord
 
class  DisturbanceCondition
 
struct  DisturbanceConditionResult
 
struct  DisturbanceHistoryCondition
 
struct  DisturbanceHistoryRecord
 
class  DisturbanceMonitorModule
 
class  DisturbanceRecord
 
class  DisturbanceSequenceSubCondition
 
class  DisturbanceTypeRecord
 
class  DynamicGrowthCurveLookupTransform
 
class  DynamicGrowthCurveTransform
 
struct  Environment_data
 
class  ErrorRecord
 
class  ESGYMModule
 
class  ESGYMSpinupSequencer
 
class  FlatAgeAreaRecord
 
class  FlatDisturbanceRecord
 
class  FlatErrorRecord
 
class  FlatFluxRecord
 
class  FlatPoolRecord
 
class  FlatRecordHelper
 
class  FluxRecord
 
class  GrowthCurveTransform
 
class  GrowthMultiplierModule
 
class  GrowthMultiplierSeries
 
class  GrowthMultiplierSet
 
class  HardwoodRootBiomassEquation
 
class  Helper
 
class  IDisturbanceSubCondition
 
class  IRecoveryRule
 
class  LandClassRecord
 
struct  lm_control_type
 
struct  lm_data_type
 
class  LmEval
 
class  LmMin
 
class  LocationErrorRecord
 
class  ModuleInfoRecord
 
class  MossDecayModule
 Parameters for moss related computing. More...
 
class  MossDisturbanceModule
 
class  MossGrowthModule
 
class  MossTurnoverModule
 
struct  Observation
 
class  OutputerStreamFluxPostNotify
 
class  OutputerStreamPostNotify
 
class  PeatlandAfterCBMModule
 
class  PeatlandDecayModule
 
class  PeatlandDecayParameters
 
class  PeatlandDisturbance
 
class  PeatlandDisturbanceModule
 
class  PeatlandFireParameters
 
class  PeatlandGrowthcurve
 
class  PeatlandGrowthCurveTransform
 
class  PeatlandGrowthModule
 
class  PeatlandGrowthParameters
 
class  PeatlandParameters
 
class  PeatlandSpinupNext
 
class  PeatlandSpinupTurnOverModule
 
class  PeatlandTurnoverModule
 
class  PeatlandTurnoverModuleBase
 
class  PeatlandTurnoverParameters
 
class  PeatlandWTDBaseFCH4Parameters
 
class  PERDFactor
 
struct  PoolDecayParameters
 
class  PoolDisturbanceSubCondition
 
class  PoolInfoRecord
 
class  PoolRecord
 
class  PrintPools
 
class  RootBiomassCarbonIncrement
 
class  RootBiomassEquation
 
struct  RootProportions
 
class  SawtoothMatrixWrapper
 
class  SawtoothModule
 
struct  Site_data
 
class  SmallTreeGrowthCurve
 
class  SmallTreeGrowthModule
 
class  Smoother
 
class  SoftwoodRootBiomassEquation
 
class  StandBiomassCarbonCurve
 
class  StandComponent
 
class  StandGrowthCurve
 
class  StandGrowthCurveFactory
 
class  StandMaturityModule
 
class  TemporalLocationRecord
 
class  TimeRecoveryRule
 
class  TimeSeries
 Encapsulates a timeseries of data. Normal usage allows modules to retrieve the most relevant data for the current timestep of the simulation. More...
 
class  TimeSeries2
 
class  TimeSeriesIdxFromFlintDataTransform
 
class  TransitionRule
 
class  TransitionRuleTransform
 
class  TreeSpecies
 
class  TreeYieldTable
 ADT - Tree yield table More...
 
class  TurnoverRates
 
class  VariableDisturbanceSubCondition
 
class  VolumeToBiomassCarbonGrowth
 
class  VolumeToBiomassConverter
 
class  YieldTableGrowthModule
 

Typedefs

typedef Poco::Tuple< Int64, int, int, int, int, double, double > DateRow
 
typedef std::tuple< Int64, int, int, int, int, double, double > StdDateRow
 
typedef Poco::Tuple< Int64, Int64, Int64, Int64, Poco::Nullable< Int64 >, double > TemporalLocationRow
 
typedef std::tuple< Int64, Int64, Int64, Int64, std::optional< Int64 >, double > StdTemporalLocationRow
 
typedef Poco::Tuple< Int64, int, int, int, int, std::string > ModuleInfoRow
 
typedef std::tuple< Int64, int, int, int, int, std::string > StdModuleInfoRow
 
typedef Poco::Tuple< Int64, int, std::string > DisturbanceTypeRow
 
typedef std::tuple< Int64, int, std::string > StdDisturbanceTypeRow
 
typedef Poco::Tuple< Int64, std::string > PoolInfoRow
 
typedef Poco::Tuple< Int64, std::string > LandClassRow
 
typedef std::tuple< Int64, std::string > StdLandClassRow
 
typedef Poco::Tuple< Int64, std::vector< Poco::Nullable< std::string > > > ClassifierSetRow
 
typedef Poco::Tuple< Int64, Int64, Int64, Int64, double > DisturbanceRow
 
typedef std::tuple< Int64, Int64, Int64, Int64, double > StdDisturbanceRow
 
typedef Poco::Tuple< Int64, Int64, Int64, Poco::Nullable< Int64 >, Int64, Int64, double > FluxRow
 
typedef std::tuple< Int64, Int64, Int64, std::optional< Int64 >, Int64, Int64, double > StdFluxRow
 
typedef Poco::Tuple< Int64, Int64, Int64, double > PoolRow
 
typedef std::tuple< Int64, Int64, Int64, double > StdPoolRow
 
typedef Poco::Tuple< Int64, std::string, std::string > ErrorRow
 
typedef std::tuple< Int64, std::string, std::string > StdErrorRow
 
typedef Poco::Tuple< Int64, Int64, Int64 > LocationErrorRow
 
typedef std::tuple< Int64, Int64, Int64 > StdLocationErrorRow
 
typedef Poco::Tuple< Int64, Int64, Int64, double > AgeAreaRow
 
typedef std::tuple< Int64, Int64, Int64, double > StdAgeAreaRow
 
typedef Poco::Tuple< Int64, Int64, Int64 > AgeClassRow
 
typedef std::tuple< Int64, Int64, Int64 > StdAgeClassRow
 

Enumerations

enum  DisturbanceConditionType {
  LessThan, EqualTo, AtLeast, Between,
  In, NotIn
}
 
enum  AgeResetType { Absolute, Relative, Yield }
 
enum  PeatlandType { Bog = 1, PoolFen, RichFen, Swamp }
 
enum  PeatlandLandCoverType { Open = 1, Treed, Forested }
 
enum  Peatlands : int {
  OPEN_PEATLAND_BOG = 1, OPEN_PEATLAND_POORFEN = 4, OPEN_PEATLAND_RICHFEN = 7, TREED_PEATLAND_BOG = 2,
  TREED_PEATLAND_POORFEN = 5, TREED_PEATLAND_RICHFEN = 8, TREED_PEATLAND_SWAMP = 10, FOREST_PEATLAND_BOG = 3,
  FOREST_PEATLAND_POORFEN = 6, FOREST_PEATLAND_RICHFEN = 9, FOREST_PEATLAND_SWAMP = 11
}
 
enum  COMPONENT {
  BARK =1, BRANCH, FOLIAGE, STEMWOOD,
  OTHER
}
 
enum  ExtrapType { NearestYr = 0, CycleYrs, AvgYr }
 
enum  DateOrigin { Calendar = 0, StartSim, Sprout }
 The date origin of the timeseries. Calendar allows yr0 to be
specified as a year. StartSim means that yr0 is a timestep in the same units as dataPerYr. More...
 
enum  Frequency { Annual, Monthly, Daily, Observations }
 
enum  InterpType { Linear, ColAverage }
 
enum  SubSamplingMode { None, Interpolate }
 
enum  SpeciesType { Softwood = 1, Hardwood }
 Enumeration of tree species type, softwood or hardwood. More...
 

Functions

TimeSeries convertDynamicObjectToTimeSeries (const DynamicObject &s)
 Converts a DynamicObject containing TimeSeries configuration to an actual TimeSeries object. Configuration must be in the format: { "$time_series": { "year_0": <first timestep of data>, "data_per_year": <data points per year>, "n_years": <years of data>, "sub_same": <sub-timesteps use whole year value>, "values": <the raw timeseries data> } } More...
 
TimeSeries convertDynamicToTimeSeries (const DynamicVar &value)
 
DynamicVar convertTimeSeriesToDynamic (const TimeSeries &timeseries)
 

Variables

const char * lm_infmsg []
 
const char * lm_shortmsg []
 
void * Sawtooth_Handle = NULL
 
thread_local void * Sawtooth_Stand_Handle = NULL
 

Typedef Documentation

◆ AgeAreaRow

typedef Poco::Tuple<Int64, Int64, Int64, double> AgeAreaRow

◆ AgeClassRow

typedef Poco::Tuple<Int64, Int64, Int64> AgeClassRow

◆ ClassifierSetRow

typedef Poco::Tuple<Int64, std::vector<Poco::Nullable<std::string> > > ClassifierSetRow

◆ DateRow

typedef Poco::Tuple<Int64, int, int, int, int, double, double> DateRow

◆ DisturbanceRow

typedef Poco::Tuple<Int64, Int64, Int64, Int64, double> DisturbanceRow

◆ DisturbanceTypeRow

typedef Poco::Tuple<Int64, int, std::string> DisturbanceTypeRow

◆ ErrorRow

typedef Poco::Tuple<Int64, std::string, std::string> ErrorRow

◆ FluxRow

typedef Poco::Tuple<Int64, Int64, Int64, Poco::Nullable<Int64>, Int64, Int64, double> FluxRow

◆ LandClassRow

typedef Poco::Tuple<Int64, std::string> LandClassRow

◆ LocationErrorRow

typedef Poco::Tuple<Int64, Int64, Int64> LocationErrorRow

◆ ModuleInfoRow

typedef Poco::Tuple<Int64, int, int, int, int, std::string> ModuleInfoRow

◆ PoolInfoRow

typedef Poco::Tuple<Int64, std::string> PoolInfoRow

◆ PoolRow

typedef Poco::Tuple<Int64, Int64, Int64, double> PoolRow

◆ StdAgeAreaRow

typedef std::tuple<Int64, Int64, Int64, double> StdAgeAreaRow

◆ StdAgeClassRow

typedef std::tuple<Int64, Int64, Int64> StdAgeClassRow

◆ StdDateRow

typedef std::tuple<Int64, int, int, int, int, double, double> StdDateRow

◆ StdDisturbanceRow

typedef std::tuple<Int64, Int64, Int64, Int64, double> StdDisturbanceRow

◆ StdDisturbanceTypeRow

typedef std::tuple<Int64, int, std::string> StdDisturbanceTypeRow

◆ StdErrorRow

typedef std::tuple<Int64, std::string, std::string> StdErrorRow

◆ StdFluxRow

typedef std::tuple<Int64, Int64, Int64, std::optional<Int64>, Int64, Int64, double> StdFluxRow

◆ StdLandClassRow

typedef std::tuple<Int64, std::string> StdLandClassRow

◆ StdLocationErrorRow

typedef std::tuple<Int64, Int64, Int64> StdLocationErrorRow

◆ StdModuleInfoRow

typedef std::tuple<Int64, int, int, int, int, std::string> StdModuleInfoRow

◆ StdPoolRow

typedef std::tuple<Int64, Int64, Int64, double> StdPoolRow

◆ StdTemporalLocationRow

typedef std::tuple<Int64, Int64, Int64, Int64, std::optional<Int64>, double> StdTemporalLocationRow

◆ TemporalLocationRow

typedef Poco::Tuple<Int64, Int64, Int64, Int64, Poco::Nullable<Int64>, double> TemporalLocationRow

Enumeration Type Documentation

◆ AgeResetType

enum AgeResetType
strong
Enumerator
Absolute 
Relative 
Yield 

◆ COMPONENT

enum COMPONENT
strong
Enumerator
BARK 
BRANCH 
FOLIAGE 
STEMWOOD 
OTHER 

◆ DateOrigin

enum DateOrigin
strong

The date origin of the timeseries. Calendar allows yr0 to be
specified as a year. StartSim means that yr0 is a timestep in the same units as dataPerYr.

Enumerator
Calendar 
StartSim 
Sprout 

◆ DisturbanceConditionType

enum DisturbanceConditionType
strong
Enumerator
LessThan 
EqualTo 
AtLeast 
Between 
In 
NotIn 

◆ ExtrapType

enum ExtrapType
strong
Enumerator
NearestYr 
CycleYrs 
AvgYr 

◆ Frequency

enum Frequency
strong
Enumerator
Annual 
Monthly 
Daily 
Observations 

◆ InterpType

enum InterpType
strong
Enumerator
Linear 
ColAverage 

◆ PeatlandLandCoverType

enum PeatlandLandCoverType
strong
Enumerator
Open 
Treed 
Forested 

◆ Peatlands

enum Peatlands : int
strong
Enumerator
OPEN_PEATLAND_BOG 
OPEN_PEATLAND_POORFEN 
OPEN_PEATLAND_RICHFEN 
TREED_PEATLAND_BOG 
TREED_PEATLAND_POORFEN 
TREED_PEATLAND_RICHFEN 
TREED_PEATLAND_SWAMP 
FOREST_PEATLAND_BOG 
FOREST_PEATLAND_POORFEN 
FOREST_PEATLAND_RICHFEN 
FOREST_PEATLAND_SWAMP 

◆ PeatlandType

enum PeatlandType
strong
Enumerator
Bog 
PoolFen 
RichFen 
Swamp 

◆ SpeciesType

enum SpeciesType
strong

Enumeration of tree species type, softwood or hardwood.

Enumerator
Softwood 
Hardwood 

◆ SubSamplingMode

enum SubSamplingMode
strong
Enumerator
None 
Interpolate 

Function Documentation

◆ convertDynamicObjectToTimeSeries()

TimeSeries moja::modules::cbm::convertDynamicObjectToTimeSeries ( const DynamicObject &  s)

Converts a DynamicObject containing TimeSeries configuration to an actual TimeSeries object. Configuration must be in the format: { "$time_series": { "year_0": <first timestep of data>, "data_per_year": <data points per year>, "n_years": <years of data>, "sub_same": <sub-timesteps use whole year value>, "values": <the raw timeseries data> } }

Exceptions
InvalidArgumentExceptionThrown when the DynamicObject does not contain all required configuration.
Parameters
sThe DynamicObject to process.
Returns
A TimeSeries object matching the specified configuration.

◆ convertDynamicToTimeSeries()

TimeSeries moja::modules::cbm::convertDynamicToTimeSeries ( const DynamicVar &  value)

◆ convertTimeSeriesToDynamic()

DynamicVar moja::modules::cbm::convertTimeSeriesToDynamic ( const TimeSeries &  timeseries)

Variable Documentation

◆ lm_infmsg

const char* lm_infmsg[]
Initial value:
= {
"improper input parameters",
"the relative error in the sum of squares is at most tol",
"the relative error between x and the solution is at most tol",
"both errors are at most tol",
"fvec is orthogonal to the columns of the jacobian to machine precision",
"number of calls to fcn has reached or exceeded 200*(n+1)",
"ftol is too small. no further reduction in the sum of squares is possible",
"xtol too small. no further improvement in approximate solution x possible",
"gtol too small. no further improvement in approximate solution x possible",
"not enough memory",
"break requested within function evaluation"
}

◆ lm_shortmsg

const char* lm_shortmsg[]
Initial value:
= {
"invalid input",
"success (f)",
"success (p)",
"success (f,p)",
"degenerate",
"call limit",
"failed (f)",
"failed (p)",
"failed (o)",
"no memory",
"user break"
}

◆ Sawtooth_Handle

void* Sawtooth_Handle = NULL

◆ Sawtooth_Stand_Handle

thread_local void* Sawtooth_Stand_Handle = NULL
Generated by   doxygen 1.8.17