cEcosimDatastructures Class |
Namespace: EwECore
The cEcosimDatastructures type exposes the following members.
Name | Description | |
---|---|---|
cEcosimDatastructures | Initializes a new instance of the cEcosimDatastructures class |
Name | Description | |
---|---|---|
NTimes |
Number of time steps to run the model for
| |
NumEnvResponseFunctions |
Name | Description | |
---|---|---|
Clear | ||
clearFishForced |
Set the FisForced() array to False of all groups
| |
ClearSummaryResults | ||
CopyTo |
Deep-copy Ecosim data structures to another instance.
| |
DefaultFishingRates |
Set default fish rate values
| |
DefaultFishMortalityRates |
Set default fish mortality values
| |
DefaultSummaryPeriods |
Set the summary time periods to using the Ecoism run length (NTime)
| |
DimForcingShapes |
Dimension all forcing function variables by ForcingPoints (number of forcing points/simulation years) and or ForcingShapes (number of forcing shapes)
| |
dimResults |
Dimension the results over time arrays i.e. ResultsOverTime(),ResultsSumCatchByGroupGear()
| |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
eraseResults |
Erase all the results arrays
| |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
getSummaryBioForGroup | ||
getSummaryBioOfCatch | ||
getSummaryCatchByGroup | ||
getSummaryCostByCatch | ||
getSummaryValueByGroup | ||
getSummaryValueOfCatch | ||
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
InitForcingShapes |
Initialize the forcing shapes to a value of one. This will overwrite an existing values
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
onEcosimRunCompleted |
An Ecosim run has completed
| |
RedimOutputsByTime | ||
redimTime | ||
RedimVars | ||
ResizeForcingShapes |
Resize the Forcing Shape Data to the new size this can be bigger or smaller then the existing number of elements
| |
ResizeMediationShapes |
Resize the Forcing Shape Data to the new size this can be bigger or smaller then the existing number of elements
| |
setEffortToDefault |
Set effort to default value for all the fleets in list
| |
setRelQToT | ||
SummarizeResults |
Computed summarized results for Ecosim
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Name | Description | |
---|---|---|
AbortRun | ||
ActivePair | ||
Alink | ||
ArenaLink | ||
ArenaNo | ||
AssimEff | ||
bAlwaysCalcTLc | Toggle to enable TL calculations during searches. Normally this
is not enabled because TL info is not used by searches. | |
BaseTimeSwitch | ||
BiomassOn | ||
BioMedData |
Mediation data for Biomass Mediation
| |
bMultiThreaded |
Boolean flag that tells Ecosim to run on it's own thread.
| |
BoutFeeding | ||
bTimestepOutput |
Boolean flag set by the calling routine to tell Ecosim if it should process the output timestep data cEcoSImModel.ProcessTimeStep()
| |
CapBaseGrowth | ||
CapDepreciate | ||
CapEnvResData |
Capacity Environmental Response functions (mediation functions).
Shape to convert input value to capacity value e.g. CapacityMap(irow,icol) = F(InputMap(irow,icol)) (capacity as a function of X)
| |
CatchSim | Total catch per timestep | |
Cbase | ||
CmCo | QBmax/QBo for handling time > 1. | |
Consumpt | ||
Consumption |
Base consumption on a prey by a predator
| |
DCPct | ||
DEFAULT_N_FORCINGPOINTS | ||
DetritusOut |
Base rate of Detritus accumulation ([accumulated detritus biomass]/[biomass t=0]) calculated in SimDetritusMT.
| |
Discount | Discount rate (% per year). | |
Eatenby | ||
Eatenof | ||
EcosimEnvResFunctions | ||
EffortConversionFactor |
Unit conversion factor for fishing effort
| |
EggProdShape | ||
Elect | ||
Emig | ||
EmploymentValueByFleet | Summarized Jobs from results | |
EnvRespFuncIndex |
Index of the Response function that has been applied to this EnviromentalDrive and Group (driver,group)
| |
Epower | ||
EquilibriumStepSize | Equilibrium step size. | |
EquilScaleMax | Equilibrium max. fishing rate (relative). | |
EvolveIsOn | ||
FIB | FIB index (x time) | |
FirstTime | ||
FisForced | ||
Fish1 | Mortality due to fishing FCatch(group) / EcopathBiomass(group) by group | |
FishMGear |
Fishing mortality by Fleet, Group
| |
FishRateGear |
Fishing Effort multiplier relative to Ecopath base, by Fleet, Time.
| |
FishRateGearBasis | ||
FishRateGearDBID | ||
FishRateGearTitle | ||
FishRateMax | Max catch rate ??? | |
FishRateNo |
Fishing mortality over time for each group.
| |
FishRateNoDBID | ||
FishRateNoTitle | ||
FishTime |
Mortality due to fishing at the current time step
| |
FleetDBID | Array of Ecosim fleet database IDs. | |
FlowType | ||
ForagingTimeLowerLimit | ||
ForcePoints | ||
FORCING_POINTS_PER_YEAR | ||
ForcingDBIDs |
Unique database IDs for forcing shapes.
| |
ForcingShapeParams | ||
ForcingShapeType | ||
ForcingTitles | ||
Ftime |
Feeding Time scaling value
| |
FtimeAdjust | Feeding time adjustment rate (0-1). | |
FtimeMax | Max relative feeding time. | |
GroupDBID | Array of Ecosim group database IDs. | |
GroupDetritus |
Detritus from all sources by group
| |
Hden | ||
Htime | ||
iadult | ||
Iarena | ||
ijuv | ||
ilink | iPrey for inlinks | |
IlinkSet | ||
IndicesOn | ||
inlinks | Total number of links/flow between groups | |
Integrate | ||
isSeasonal | ||
Jarena | ||
jlink | iPred for inlinks | |
JlinkSet | ||
Kemptons | Kemptons's Q | |
KlinkSet | ||
loss | ||
lstEnviroInputData | ||
maxflow | ||
maxtimejuv | ||
mintimejuv | ||
mo |
Mortality other computed as (1-ee)*pb
| |
MoPred | Fraction of other mortality. | |
MPred |
Mortalily rate due to predation by Link
| |
Narena | ||
nGear | Total number of fleets in the model. | |
nGroups | Total number of groups in the model. | |
NlinksSet | ||
NoIntegrate |
Flag for doing integration in rk4 for each group
| |
nSumTimeSteps | Number of timesteps in the summary data | |
NudgeChecked | ||
NumForcingShapes | ||
NumStep | Number of time steps for averaging results. | |
NumStep0 | ||
NumStep1 | ||
NumStepsPerYear | Number of steps per year. | |
NumYears | Duration of simulation (years). | |
NutBaseFreeProp | Base proportion of free nutrients. | |
NutBiom | Sum of biomass across all groups | |
NutForceNumber | Nutrient loading forcing function number. This is an index in the tval() array. | |
NutFree | Nutrient free in the enviroment | |
NutFreeBase | ||
NutMin | ||
NutPBmax | Max PB/(Base PB) due to nutrient concent. | |
NutTot | Total nutrient bound in system | |
pbbiomass | pbbiomass = (PB * MaxPB / PB - 1) / B | |
pbm | Max PB = PBmax*PB | |
PBmaxs | ||
PcapBase | ||
PeatArena | ||
PeatArenaSetFromDataBase | ||
pred | ||
PredictSimEffort | ||
PredPreyResultsOverTime | pred/prey(2) x groups x groups x time | |
PriceMedData |
Mediation data for Price Elasticity (mediation function)
| |
ProfitByFleet | Summarized Profit from results | |
PropDiscardMortTime | ||
Propdiscardtime |
Proportion of the total catch that suffered mortality for the current time step (by gear group). Does not include discards that survived.
Initialized in cEcosim.InitPropLanded() Propdiscardtime(iflt, igrp) = PropDiscard(iflt, igrp) * PropDiscardMort(iflt, igrp)
| |
PropLandedTime | Proportion of regulated landings (by gear group) for the current time step | |
QBoutside | ||
Qlink | ||
Qmain | ||
QmQo | Density-dependant catchability QMax/Qo. | |
Qrisk | ||
RecPower | ||
RelaSwitch | ||
relQ |
Catch Rate at Ecopath base. Include all catch even discards that survive. set in SetRelativeCatchabilities
| |
relQt | ||
ResultsAvgByPreyPred | pred/prey(2) x groups x groups | |
ResultsDiscardsMort | ||
ResultsDiscardsSurvived | ||
ResultsEffort | ||
ResultsLandings | Landings by Group, Fleet | |
ResultsOverTime |
Model results over time (number of variables x groups x time)
| |
ResultsSumCatchByGear | fleets x time | |
ResultsSumCatchByGroupGear | Group x fleets x time. | |
ResultsSumFMortByGroupGear |
Fishing mortality by time
| |
ResultsSumRelValueByGroup | ||
ResultsSumValueByGear | ||
ResultsSumValueByGroupGear | ||
ResultsTimeDiscardsGroupGear | Total discards by Group, fleets, time. | |
ResultsTimeDiscardsMortGroupGear | Discards that suffered mortality by Group, fleets, time. | |
ResultsTimeDiscardsSurvivedGroupGear | Discards that survived by Group, fleets, time. | |
ResultsTimeLandingsGroupGear |
Landing by Group, Fleet, Time.
| |
RiskTime | Predation effect on feeding time (0-1). | |
ShannonDiversity | Shannon Diversity Index | |
SimDC | ||
simDCAtT | ||
SimGE | ||
SorWt | Relaxation parameter [0,1]. | |
SS |
Sum of squares fit to reference data
| |
SSGroup |
Sum of squares by group
| |
StartBiomass | ||
StepSize | Integration steps (per year). | |
StepsPerMonth |
Number of sub timesteps Ecosim will run per month
| |
SumBiomass | ||
SumCatch | ||
SumStart | Start time of the first and second summary data period. In Years | |
SwitchPower | Switching power parameter (0-2). | |
SystemRecovery | System recovery (+/- %). | |
TimeJuv | ||
TLC | TL of catch (x time) | |
TLSim | TL based on Ecosim diets (x group) | |
ToDetritus | ||
TrophicOff | ||
tval | ||
UseVarPQ | ||
VulArena | ||
VulMult |
Vulnerability multiplier of a prey to a predator
| |
VulMultAll | ||
VulnerabilityPredator | Max vulnerability across all prey for this predator VulnerabilityPredator(pred) = max(VulMult(prey,pred)) | |
vulrate | ||
ZmaxScale | ||
zscale |
Name | Description | |
---|---|---|
Value |
Extension method; extract a value from an object by property name.
(Defined by Extensions.) |