cEcospaceDataStructures Class |
[Missing <summary> documentation for "T:EwECore.cEcospaceDataStructures"]
Namespace: EwECore
The cEcospaceDataStructures type exposes the following members.
Name | Description | |
---|---|---|
cEcospaceDataStructures | Initializes a new instance of the cEcospaceDataStructures class |
Name | Description | |
---|---|---|
getLayerIDs |
Obtain a layer DBID for any varname and index.
| |
isAdvectionActive |
Returns whether any group is Advected
| |
isCapacityChanged |
Have any of the capacity input layers changed
| |
isEcosimBiomassForcingLoaded |
Returns whether any group is forced through biomass timeseries in Ecosim.
| |
isEcosimDiscardForcingLoaded |
Returns whether any group is forced through discards timeseries in Ecosim.
| |
nCellsInRegion | ||
NGroups | Number of Base Groups (Ecopath) | |
nTimeSteps | ||
nTimeStepsPerYear |
Number of Ecospace time steps per year at the current time step | |
TotalTime |
Name | Description | |
---|---|---|
AverageSpatialResults |
Average the results values over number of water cells
| |
Clear | ||
DefaultBasemapDimensions |
Set the Map to its default size
| |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
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.) | |
getLayerID |
Return the unique database ID
for any Ecospace map layer.
| |
getSumBiom |
Get Biomass for summary periods
| |
getSumBiomByRegion |
Get sum of Biomass by Region Group for the Start and End summary period
| |
getSumCatchFleet |
Get Catch by Fleet for summary periods
| |
getSumCatchFleetGroup |
Get Catch by Fleet Group for summary periods
| |
getSumCatchRegionGearGroup |
Get Catch by REgion, Fleet, Group for summary periods
| |
getSumCostFleet |
Get Cost by Fleet for summary periods
| |
getSumEffortES |
Get Value by Fleet for summary periods
| |
getSumValueFleet |
Get Value by Fleet for summary periods
| |
getSumValueFleetGroup |
Get Value by Fleet Group for summary periods
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
PopulateFleetCells | ||
RedimConSimVars | ||
ReDimEffortZones |
Dimensions and sets the number of Effort Zones
| |
ReDimFleets | ||
redimForReferenceData |
Ecospace spatial reference data not used but left in place for legacy reasons
| |
RedimGroups | ||
RedimHabitatVariables |
Re-dimension the habitat variables
| |
ReDimMapDims | ||
ReDimMapVars | ||
RedimMigratoryVariables |
Redim variables for migratory preferences
| |
RedimMPAVariables |
Redim variables for MPAs
| |
redimTimeStepResults |
Redim the data that saves the Ecospace results over time
| |
restoreBaseRelPP |
Restore RelPP map from the RelPP0 temporary array.
| |
setBaseRelPP |
Preserve RelPP map in the RelPP0 temporary array.
| |
setDebugCapMaps |
Hardwire some Capacity map values
| |
SetDefaults |
Set default values and dimemsion basic arrays
| |
setDefaultSummaryPeriod | ||
SetDefaultThreads | ||
setHabCapGroupIsChanged |
Set the isGroupHabCapChanged() flag to True or False for all the groups
| |
setNWaterCells |
Count the number of water cells and sets public property nWaterCells
| |
SummarizeResultsByFleet | ||
ToCellLength | ||
ToCellSize | ||
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Name | Description | |
---|---|---|
AdjustSpace | ||
AdvectSpeed | ||
AMmTr | ||
Aspace | ||
AssumeSquareCells |
Get/set whether Ecospace will use square cells, e.g. will bypass cell width corrections.
| |
barrierAvoidanceWeight | This determines how much weight is put into the pathfinding movement algorithm for migratory species. If fish are getting caught in complex habitat, increasing this value will help the fish get "un-stuck". Possible values [0-1] Increasing this will increase the concentration of the fish, so the regular NS/EW concentrations should be lowered to keep the concentration the same. | |
Basebiomass | ||
BaseCatch | ||
BaseConsump | ||
BaseFishMort | ||
BasePredMort | ||
BBase |
Ecospace base biomass gathered at the end of the first timestep after any spinup period.
| |
bCalTrophicLevel |
Calculate the TrophicLevel map in Ecospace.
True Ecospace will populate the TrophicLevel map in cEcospaceDataStructures.TL.
| |
Bcell | Biomass by cell (row, col, group) | |
bENA | ||
bInSpinUp | Are we in a Spin-Up period | |
Blast | ||
Bnew | ||
BRatio |
Ratio of habitat area to total habitat capacity
| |
bUseEffortDistThreshold |
Boolean flag is fishing effort restricted to cells with a Sail() of less than EffortDistThreshold
| |
bUseLocalMemory | ||
ByPassIntegrate | ||
CapCalType |
Capacity calculation type per group
| |
CapMapFunctions | ||
CapMaps | ||
CatchFleetMap | Catch by Row, Col, Fleet. | |
CatchMap | Catch by Row, Col, Group. | |
Ccell | Contaminant by cell (row, col, group) | |
CellLength | Length in KM of a cell, used for dispersal etc. | |
Clast | ||
CurrentForce | ||
dctENACells | ||
DEFAULT_COORDINATESYSTEM | ESRI projection string of the default WGS_84 projection of Ecospace. | |
Depth | Actual depth map as used by Ecospace, computed from DepthInput and Excluded. | |
DepthA | ||
DepthInput | User-entered depth map | |
DepthX | ||
DepthY | ||
der | ||
DiscardsMap | Discards (all? mortality?) by Row, Col, Group. | |
EcoPathData | ||
EcopathFleetDBID | Array of mappings to ecopath fleet database IDs. | |
EcopathGroupDBID | Array of mappings to ecopath group database IDs. | |
EcoseedOn | ||
EcosimScenarioDBID | ||
EcospaceAreaOutputDir |
User defined output directory for Ecospace Area Averaged outputs
| |
EcospaceMapOutputDir |
User defined output directory for Ecospace output Maps
| |
EffortDistThreshold |
Threshold value in the Sail(fleet,row,col) [sailing cost map] for a cells inclusion in effort distribution.
| |
EffortSpace |
Fishing Mortality (catchrate) by a fleet for each cell fleet,row,col
| |
EffPower | ||
EffZones |
Index of the Effort Zone a cell is in by Row Col
| |
EnvironmentalLayerDBID | Environmental layer database IDS | |
EnvironmentalLayerDescription | Environmental layer descriptions | |
EnvironmentalLayerMap | Environmental layer data (layer)(row, col) | |
EnvironmentalLayerName | Environmental layer names | |
EnvironmentalLayerUnits | Environmental layer units | |
Excluded | Is a cell included in modeling by Row, Col. | |
FirstOutputTimeStep |
First model time step to being writing Ecospace output files
| |
FitnessResp |
Inverse of emigration response to fitness
| |
FleetDBID | Array of ecospace Fleet database IDs. | |
FleetSailCells |
List of map cells that have a value in the Sail(,,)array less than EffortDistThreshold
| |
flow | ||
Ftot |
Total fishing mortality by group,row,col
| |
Ftr | ||
GearHab | Does this Fishing fleet use this habitat type | |
GroupDBID | Array of ecospace group database IDs. | |
GroupDetritus | Detritus by Row, Col, group | |
HabArea |
Total number of habitat cells by habitat type
| |
HabAreaProportion |
Proportion of total area used by a habitat type
| |
HabCap |
Habitat Capacity by Row,Col,Group
| |
HabCapInput |
User defined input habitat capacity.
| |
HabitatDBID | Array of ecospace habitat database IDs. | |
HabitatText | Descriptive text of habitat type (name) | |
hasCapInitialized |
The Capacity model has a "one time" initialization of MaxHabCap value used for normalization of inputs.
This Flag gets set to True once MaxHabCap() has been set
| |
iEndRow | ||
IFDPower | ||
IFDweight | ||
ImportanceLayerDBID | ||
ImportanceLayerDescription | ||
ImportanceLayerMap | Importance layer data (layer)(row, col) | |
ImportanceLayerName | ||
ImportanceLayerWeight | ||
InCol | Number of rows in the current base map | |
InMigAreaMovement | Weighting for directed movement within a migratory area (groups) | |
InRow | Number of rows in the current base map | |
integratedGroups | ||
IsAdvected | ||
IsEcosimBioForcingGroup |
Is the Ecosim biomass time series forcing enabled for this group
| |
IsEcosimDiscardForcingGroup | ||
IsFishRateSet | ||
isGroupHabCapChanged | ||
IsMigratory | IsMigratory flag, per group. | |
IsSpShown | ||
iStartRow | ||
iTotalWaterCells | ||
ItoUse |
Nearest suitable map row (iPacket) for an IBM Packet by nStanzaGroups(nSplit), MaxStanzas, row, col
| |
iWaterCellIndex | ||
jEndCol | ||
jord | ||
jStartCol | ||
JtoUse |
Nearest suitable map col (jPacket) for an IBM Packet by nStanzaGroups(nSplit), MaxStanzas, row, col
| |
jWaterCellIndex | ||
KemptonsQ | Kemptons Q by Row, Col. | |
Kmovefit | ||
Landings | Sum of landings across all cells by Group/Fleet for the current timestep | |
Lat1 | Latitude of upper left coordinate of the current basemap. | |
LinkCellWidthAndSize |
Bad-ass flag, stating whether cell length can be computed from cell size and vice-versa.
This should really be properly determined from proper projections
| |
Lon1 | Longitude of upper left coordinate of the current basemap. | |
lstRegions | ||
M0Mult |
Other mortality multiplier by Row,Col,Group
| |
M0MultInput |
User-defined other mortality multiplier.
| |
MaxHabCap | max capacity by group | |
maxIter |
Maximum number of iterations that solvegrid will use to find the implicit solution for the next timestep
| |
MigMaps |
Monthly Migration maps stored in a ragged array
Dimensioned by (group,month)(row,col)
| |
MonthlyUpWell | ||
MonthlyXvel | ||
MonthlyYvel | ||
MonthNow | Current month that is being executed. | |
MovePacketsAtStanzaEntry | ||
MoveScale | ||
MPA |
MPA layout, dimensioned as mpa x (row, col)
| |
MPABiomass | ||
MPADBID | Array of ecospace MPA database IDs. | |
MPAfishery | MPA enforcement (fleet x MPA), true if an MPA is open to fishing for a given fleet | |
MPAmonth | MPA monthly open/closed state (Month x MPA), true when open for fishing. | |
MPAname | ||
MPAno | Number of MPAs | |
MPred | Predation rate by Row, Col, Prey/Pred link | |
Mrate | Movement rate?! | |
Mvel | Base dispersal rate as entered by the user | |
nEffortDistThreads |
Number of effort distribution threads
| |
nEffZones |
Number of fishing effort zones (LME's, EEZ...)
| |
nEnvironmentalDriverLayers | Number of environmental layers | |
NewMultiStanza | ||
nFleets | Number of Fishing Fleets | |
nGridSolverThreads |
Number of threads to use for the grid solvers
| |
nIBMGroupsPerThread | ||
nIBMPacketsPerThread | ||
nImportanceLayers | Number of Importance layers | |
nLiving | ||
NoHabitats | Number of Habitat types defined by the user | |
nRegions | ||
nSpaceSolverThreads |
Number of threads to run the groups biomass calculations on
| |
NumStep |
Number of time steps for averaging summary window data
| |
Nvarsplit | Total number of stanza groups | |
nvartot | total number of all groups | |
nWaterCells | Total number of cells that have water | |
PAreaFished | The proportion of map cell that is fished by a fleet. | |
PHabType | The proportion of habitat type in a map cell. | |
Port | ||
PPScale |
Primary Production Scaler average value of relPP(row,col) for all water cells
| |
PPupWell | ||
PredCell | ||
PredictEffort |
Predict fishing effort via the Gravity attraction model
| |
PrefHab | The proportion to which a group prefers a habitat. | |
PropEffortFleetZone |
Proportion of relative fishing effort for a fleet in an zone(LME,Region....) by nFleets, nEffZones
| |
Region | ||
RegionDBID | Array of ecospace region database IDs. | |
RelCin | ||
RelMoveBad | ||
RelPP | ||
RelPP0 |
Base value for relative PP (relative PP at t=0). Set after PP has been read from the database.
| |
RelVulBad | ||
ResultsByFleet | ResultsByFleet(nvars,nFleets,NumberOfTimeSteps) | |
ResultsByFleetGroup | ResultsByFleetGroup(nvars, nFleets, nGroups, nTimesteps) | |
ResultsByGroup | Summarized time step data | |
ResultsCatchRegionGearGroup | ResultsCatchRegionGearGroup( nRegions, nFleets, nGroups, nTimesteps) | |
ResultsCatchRegionGearGroupYear | ResultsCatchRegionGearGroup( nRegions, nFleets, nGroups, nYears) | |
ResultsRegionGroup | ResultsRegionGroup(nRegions, nGroups, nTimesteps) | |
ResultsRegionGroupYear | ResultsRegionGroup(nRegions, nGroups, nYears) | |
ResultsSummaryByFleet | ||
Sail |
Sailing cost (fleet x row x col)
| |
SailScale |
Average value in the Sail(fleet,row,col) map for all water cells.
| |
SaveAnnual | ||
SaveASC | ||
SaveCSV | ||
SEmult |
Sailing Effort Multiplier by Fleet
| |
ShannonDiversity | ShannonDiversity by Row, Col. | |
SpaceBiomassByRegion | ||
SpaceBiomassByRegionCount | ||
SpaceCatchByRegion | ||
SpaceCatchByRegionCount | ||
SpaceEffortByRegionFleet | ||
SpaceEffortByRegionFleetCount | ||
SpaceTime | ||
SpDat | ||
SpDatYear | ||
SpForceBB | ||
SpForceCatch | ||
SpForceZ | ||
SpinUpBBase |
Ecospace base biomass before the Spin-Up period. Gathered at the end of the first timestep.
| |
SpinUpYears |
Number of years to run the Spin-Up for
| |
SpName | ||
SpPool | ||
SpRegion | ||
SpType | ||
SpVal | ||
SpWt | ||
SpYear | ||
SS |
Sum of Squares fit to reference data
| |
StanzaGroups | ||
SumStart | Start time of the first and second summary data period. In Years | |
ThabArea |
Total number of habitat area cells
Any cell with a depth > 0 of any habitat type
| |
TimeNow | Current model time step in years. Incremented by TimeStep at the end of the timestep. | |
TimeStep |
Length of the time step in years
| |
TL | Trophic Level by Row, Col, Group. | |
TLc | Trophic Level of the catch by Row, Col. | |
Tol |
Iteration tolerance for solvegrid.
| |
totalIntegratedGroups | ||
TotEffort |
Sum of Effort modified by proportion of area fished in a cell.
| |
TotHabCap | Sum of Capacity across the map cells by group | |
UpVel | ||
UseCoreOutputDir |
Use the Ecospace Output directory defined by the core. If True this path will include Model-name/Ecopath_6. Scenario-name/
If False just the core output directory.
| |
UseEcosimBiomassForcing | ||
UseEcosimDiscardForcing | ||
UseExact | ||
UseIBM | ||
UseSpinUp |
Use a "Spin-Up" period for Ecospace
| |
UseSpinUpBase | ||
UseSpinUpPlot | ||
Vspace | ||
W |
SOR weight
| |
Width | ||
Xv | Wind X velocity (i x j x month) | |
Xvel | ||
Xvloc | ||
YearNow | Current year that is being executed. | |
Yv | Wind Y velocity (i x j x month) | |
Yvel | ||
Yvloc |
Name | Description | |
---|---|---|
Value |
Extension method; extract a value from an object by property name.
(Defined by Extensions.) |