actions

package
v0.0.0-...-c864ae1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 13, 2023 License: BSD-2-Clause, BSD-3-Clause, MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	RiparianType  ActionType = "Riparian"
	HillSlopeType ActionType = "Hillslope"
	GullyType     ActionType = "Gully"
	WetlandType   ActionType = "Wetland"

	UndefinedType ActionType = ""

	OpportunityCostAttribute             = "OpportunityCot"
	ImplementationCostAttribute          = "ImplementationCost"
	ParticulateNitrogenOriginalAttribute = "ParticulateNitrogenOriginal"
	ParticulateNitrogenActionedAttribute = "ParticulateNitrogenActioned"
	HillSlopeErosionOriginalAttribute    = "HillSlopeErosionOriginal"
	HillSlopeErosionActionedAttribute    = "HillSlopeErosionActioned"
	FineSedimentOriginalAttribute        = "FineSedimentOriginal"
	FineSedimentActionedAttribute        = "FineSedimentActioned"

	DissolvedNitrogenOriginalAttribute   = "DissolvedNitrogenOriginal"
	DissolvedNitrogenActionedAttribute   = "DissolvedNitrogenActioned"
	DissolvedNitrogenRemovalEfficiency   = "DissolvedNitrogenRemovalEfficiency"
	ParticulateNitrogenRemovalEfficiency = "ParticulateNitrogenRemovalEfficiency"
	SedimentRemovalEfficiency            = "SedimentRemovalEfficiency"
)
View Source 
const ActionedBufferVegetation action.ModelVariableName = "ActionedBufferVegetation"
View Source 
const ActionedGullySediment action.ModelVariableName = "ActionedGullySediment"
View Source 
const ActionedRiparianSedimentProduction action.ModelVariableName = "ActionedRiparianSedimentProduction"
View Source 
const GullyRestorationCost action.ModelVariableName = "GullyRestorationCost"
View Source 
const GullyRestorationOpportunityCost action.ModelVariableName = "GullyRestorationOpportunityCost"
View Source 
const GullyRestorationType action.ManagementActionType = "GullyRestoration"
View Source 
const HillSlopeRestorationCost action.ModelVariableName = "HillSlopeRestorationCost"
View Source 
const HillSlopeRestorationOpportunityCost action.ModelVariableName = "HillSlopeRestorationOpportunityCost"
View Source 
const HillSlopeRestorationType action.ManagementActionType = "HillSlopeRestoration"
View Source 
const OriginalBufferVegetation action.ModelVariableName = "OriginalBufferVegetation"
View Source 
const OriginalGullySediment action.ModelVariableName = "OriginalGullySediment"
View Source 
const OriginalRiparianSedimentProduction action.ModelVariableName = "OriginalRiparianSedimentProduction"
View Source 
const RiverBankRestorationCost action.ModelVariableName = "RiverBankRestorationCost"
View Source 
const RiverBankRestorationOpportunityCost action.ModelVariableName = "RiverBankRestorationOpportunityCost"
View Source 
const RiverBankRestorationType action.ManagementActionType = "RiverBankRestoration"
View Source 
const WetlandsEstablishmentCost action.ModelVariableName = "WetlandsEstablishmentCost"
View Source 
const WetlandsEstablishmentOpportunityCost action.ModelVariableName = "WetlandsEstablishmentOpportunityCost"
View Source 
const WetlandsEstablishmentType action.ManagementActionType = "WetlandsEstablishment"

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionType 

type ActionType string

type BankSedimentContribution 

type BankSedimentContribution struct {
	// contains filtered or unexported fields
}

func (*BankSedimentContribution) Initialise 

func (bsc *BankSedimentContribution) Initialise(planningUnitTable tables.CsvTable, parameters parameters.Parameters)

func (*BankSedimentContribution) OriginalPlanningUnitSedimentContribution 

func (bsc *BankSedimentContribution) OriginalPlanningUnitSedimentContribution(id planningunit.Id) float64

func (*BankSedimentContribution) OriginalPlanningUnitVegetationProportion 

func (bsc *BankSedimentContribution) OriginalPlanningUnitVegetationProportion(id planningunit.Id) float64

func (*BankSedimentContribution) OriginalSedimentContribution 

func (bsc *BankSedimentContribution) OriginalSedimentContribution() float64

func (*BankSedimentContribution) PlanningUnitSedimentContribution 

func (bsc *BankSedimentContribution) PlanningUnitSedimentContribution(planningUnit planningunit.Id, proportionOfIntactVegetation float64) float64

type Container 

type Container struct {
	// contains filtered or unexported fields
}

func (*Container) DeriveMapKey 

func (c *Container) DeriveMapKey(subCatchment planningunit.Id, actionType ActionType, elementType string) string

func (*Container) DeriveMapKeyComponents 

func (c *Container) DeriveMapKeyComponents(mapKey string) *KeyComponents

func (*Container) Map 

func (c *Container) Map() map[string]float64

func (*Container) MapValue 

func (c *Container) MapValue(key string) float64

func (*Container) WithActionsTable 

func (c *Container) WithActionsTable(actionsTable tables.CsvTable) *Container

func (*Container) WithFilter 

func (c *Container) WithFilter(filter ActionType) *Container

type GullyRestoration 

type GullyRestoration struct {
	action.SimpleManagementAction
}

func NewGullyRestoration 

func NewGullyRestoration() *GullyRestoration

func (*GullyRestoration) WithActionedDissolvedNitrogen 

func (g *GullyRestoration) WithActionedDissolvedNitrogen(costInDollars float64) *GullyRestoration

func (*GullyRestoration) WithActionedGullySediment 

func (g *GullyRestoration) WithActionedGullySediment(gullyVolume float64) *GullyRestoration

func (*GullyRestoration) WithActionedParticulateNitrogen 

func (g *GullyRestoration) WithActionedParticulateNitrogen(costInDollars float64) *GullyRestoration

func (*GullyRestoration) WithImplementationCost 

func (g *GullyRestoration) WithImplementationCost(costInDollars float64) *GullyRestoration

func (*GullyRestoration) WithOpportunityCost 

func (g *GullyRestoration) WithOpportunityCost(costInDollars float64) *GullyRestoration

func (*GullyRestoration) WithOriginalDissolvedNitrogen 

func (g *GullyRestoration) WithOriginalDissolvedNitrogen(costInDollars float64) *GullyRestoration

func (*GullyRestoration) WithOriginalGullySediment 

func (g *GullyRestoration) WithOriginalGullySediment(gullyVolume float64) *GullyRestoration

func (*GullyRestoration) WithOriginalParticulateNitrogen 

func (g *GullyRestoration) WithOriginalParticulateNitrogen(costInDollars float64) *GullyRestoration

func (*GullyRestoration) WithPlanningUnit 

func (g *GullyRestoration) WithPlanningUnit(planningUnit planningunit.Id) *GullyRestoration

func (*GullyRestoration) WithType 

func (g *GullyRestoration) WithType(actionType action.ManagementActionType) *GullyRestoration

func (*GullyRestoration) WithVariable 

func (g *GullyRestoration) WithVariable(variableName action.ModelVariableName, value float64) *GullyRestoration

type GullyRestorationGroup 

type GullyRestorationGroup struct {
	Container
	// contains filtered or unexported fields
}

func (*GullyRestorationGroup) ManagementActions 

func (g *GullyRestorationGroup) ManagementActions() []action.ManagementAction

func (*GullyRestorationGroup) WithActionsTable 

func (g *GullyRestorationGroup) WithActionsTable(actionsTable tables.CsvTable) *GullyRestorationGroup

func (*GullyRestorationGroup) WithGullyTable 

func (g *GullyRestorationGroup) WithGullyTable(gullyTable tables.CsvTable) *GullyRestorationGroup

func (*GullyRestorationGroup) WithParameters 

func (g *GullyRestorationGroup) WithParameters(parameters parameters.Parameters) *GullyRestorationGroup

type GullySedimentContribution 

type GullySedimentContribution struct {
	// contains filtered or unexported fields
}

func (*GullySedimentContribution) ChannelLength 

func (bsc *GullySedimentContribution) ChannelLength(planningUnit planningunit.Id) float64

func (*GullySedimentContribution) Initialise 

func (bsc *GullySedimentContribution) Initialise(gulliesTable tables.CsvTable, parameters parameters.Parameters)

func (*GullySedimentContribution) OriginalSedimentContribution 

func (bsc *GullySedimentContribution) OriginalSedimentContribution() float64

func (*GullySedimentContribution) SedimentContribution 

func (bsc *GullySedimentContribution) SedimentContribution(planningUnit planningunit.Id) float64

func (*GullySedimentContribution) SedimentFromVolume 

func (bsc *GullySedimentContribution) SedimentFromVolume(gullyVolume float64) float64

type HillSlopeRestoration 

type HillSlopeRestoration struct {
	action.SimpleManagementAction
}

func NewHillSlopeRestoration 

func NewHillSlopeRestoration() *HillSlopeRestoration

func (*HillSlopeRestoration) WithActionedDissolvedNitrogen 

func (h *HillSlopeRestoration) WithActionedDissolvedNitrogen(costInDollars float64) *HillSlopeRestoration

func (*HillSlopeRestoration) WithActionedParticulateNitrogen 

func (h *HillSlopeRestoration) WithActionedParticulateNitrogen(costInDollars float64) *HillSlopeRestoration

func (*HillSlopeRestoration) WithActionedSedimentErosion 

func (h *HillSlopeRestoration) WithActionedSedimentErosion(costInDollars float64) *HillSlopeRestoration

func (*HillSlopeRestoration) WithImplementationCost 

func (h *HillSlopeRestoration) WithImplementationCost(costInDollars float64) *HillSlopeRestoration

func (*HillSlopeRestoration) WithOpportunityCost 

func (h *HillSlopeRestoration) WithOpportunityCost(costInDollars float64) *HillSlopeRestoration

func (*HillSlopeRestoration) WithOriginalDissolvedNitrogen 

func (h *HillSlopeRestoration) WithOriginalDissolvedNitrogen(costInDollars float64) *HillSlopeRestoration

func (*HillSlopeRestoration) WithOriginalParticulateNitrogen 

func (h *HillSlopeRestoration) WithOriginalParticulateNitrogen(costInDollars float64) *HillSlopeRestoration

func (*HillSlopeRestoration) WithOriginalSedimentErosion 

func (h *HillSlopeRestoration) WithOriginalSedimentErosion(costInDollars float64) *HillSlopeRestoration

func (*HillSlopeRestoration) WithPlanningUnit 

func (h *HillSlopeRestoration) WithPlanningUnit(planningUnit planningunit.Id) *HillSlopeRestoration

func (*HillSlopeRestoration) WithType 

func (h *HillSlopeRestoration) WithType(actionType action.ManagementActionType) *HillSlopeRestoration

func (*HillSlopeRestoration) WithVariable 

func (h *HillSlopeRestoration) WithVariable(variableName action.ModelVariableName, value float64) *HillSlopeRestoration

type HillSlopeRestorationGroup 

type HillSlopeRestorationGroup struct {
	Container
	// contains filtered or unexported fields
}

func (*HillSlopeRestorationGroup) ManagementActions 

func (h *HillSlopeRestorationGroup) ManagementActions() []action.ManagementAction

func (*HillSlopeRestorationGroup) WithActionsTable 

func (h *HillSlopeRestorationGroup) WithActionsTable(actionsTable tables.CsvTable) *HillSlopeRestorationGroup

func (*HillSlopeRestorationGroup) WithParameters 

func (h *HillSlopeRestorationGroup) WithParameters(parameters parameters.Parameters) *HillSlopeRestorationGroup

func (*HillSlopeRestorationGroup) WithPlanningUnitTable 

func (h *HillSlopeRestorationGroup) WithPlanningUnitTable(planningUnitTable tables.CsvTable) *HillSlopeRestorationGroup

type HillSlopeSedimentContribution 

type HillSlopeSedimentContribution struct {
	Container
	// contains filtered or unexported fields
}

func (*HillSlopeSedimentContribution) Initialise 

func (h *HillSlopeSedimentContribution) Initialise(dataSet *dataset.DataSetImpl, parameters parameters.Parameters)

func (*HillSlopeSedimentContribution) OriginalSubCatchmentSedimentContribution 

func (h *HillSlopeSedimentContribution) OriginalSubCatchmentSedimentContribution(id planningunit.Id) float64

func (*HillSlopeSedimentContribution) SubCatchmentSedimentContribution 

func (h *HillSlopeSedimentContribution) SubCatchmentSedimentContribution(id planningunit.Id, rawSedimentProduced float64) float64

type KeyComponents 

type KeyComponents struct {
	SubCatchment planningunit.Id
	Action       ActionType
	ElementType  string
}

type RiverBankRestoration 

type RiverBankRestoration struct {
	action.SimpleManagementAction
}

func NewRiverBankRestoration 

func NewRiverBankRestoration() *RiverBankRestoration

func (*RiverBankRestoration) WithActionedBufferVegetation 

func (r *RiverBankRestoration) WithActionedBufferVegetation(proportionOfVegetation float64) *RiverBankRestoration

func (*RiverBankRestoration) WithActionedDissolvedNitrogen 

func (r *RiverBankRestoration) WithActionedDissolvedNitrogen(dissolvedNitrogen float64) *RiverBankRestoration

func (*RiverBankRestoration) WithActionedFineSediment 

func (r *RiverBankRestoration) WithActionedFineSediment(fineSediment float64) *RiverBankRestoration

func (*RiverBankRestoration) WithActionedParticulateNitrogen 

func (r *RiverBankRestoration) WithActionedParticulateNitrogen(particulateNitrogen float64) *RiverBankRestoration

func (*RiverBankRestoration) WithActionedRiparianSedimentProduction 

func (r *RiverBankRestoration) WithActionedRiparianSedimentProduction(sediment float64) *RiverBankRestoration

func (*RiverBankRestoration) WithDissolvedNitrogenRemovalEfficiency 

func (r *RiverBankRestoration) WithDissolvedNitrogenRemovalEfficiency(removalEfficiency float64) *RiverBankRestoration

func (*RiverBankRestoration) WithImplementationCost 

func (r *RiverBankRestoration) WithImplementationCost(costInDollars float64) *RiverBankRestoration

func (*RiverBankRestoration) WithOpportunityCost 

func (r *RiverBankRestoration) WithOpportunityCost(costInDollars float64) *RiverBankRestoration

func (*RiverBankRestoration) WithOriginalBufferVegetation 

func (r *RiverBankRestoration) WithOriginalBufferVegetation(proportionOfVegetation float64) *RiverBankRestoration

func (*RiverBankRestoration) WithOriginalDissolvedNitrogen 

func (r *RiverBankRestoration) WithOriginalDissolvedNitrogen(dissolvedNitrogen float64) *RiverBankRestoration

func (*RiverBankRestoration) WithOriginalFineSediment 

func (r *RiverBankRestoration) WithOriginalFineSediment(fineSediment float64) *RiverBankRestoration

func (*RiverBankRestoration) WithOriginalParticulateNitrogen 

func (r *RiverBankRestoration) WithOriginalParticulateNitrogen(particulateNitrogen float64) *RiverBankRestoration

func (*RiverBankRestoration) WithOriginalRiparianSedimentProduction 

func (r *RiverBankRestoration) WithOriginalRiparianSedimentProduction(sediment float64) *RiverBankRestoration

func (*RiverBankRestoration) WithPlanningUnit 

func (r *RiverBankRestoration) WithPlanningUnit(planningUnit planningunit.Id) *RiverBankRestoration

func (*RiverBankRestoration) WithType 

func (r *RiverBankRestoration) WithType(actionType action.ManagementActionType) *RiverBankRestoration

func (*RiverBankRestoration) WithVariable 

func (r *RiverBankRestoration) WithVariable(variableName action.ModelVariableName, value float64) *RiverBankRestoration

type RiverBankRestorationGroup 

type RiverBankRestorationGroup struct {
	Container
	// contains filtered or unexported fields
}

func (*RiverBankRestorationGroup) ManagementActions 

func (r *RiverBankRestorationGroup) ManagementActions() []action.ManagementAction

func (*RiverBankRestorationGroup) WithActionsTable 

func (r *RiverBankRestorationGroup) WithActionsTable(parentSoilsTable tables.CsvTable) *RiverBankRestorationGroup

func (*RiverBankRestorationGroup) WithParameters 

func (r *RiverBankRestorationGroup) WithParameters(parameters parameters.Parameters) *RiverBankRestorationGroup

func (*RiverBankRestorationGroup) WithPlanningUnitTable 

func (r *RiverBankRestorationGroup) WithPlanningUnitTable(planningUnitTable tables.CsvTable) *RiverBankRestorationGroup

type WetlandsEstablishment 

type WetlandsEstablishment struct {
	action.SimpleManagementAction
}

func NewWetlandsEstablishment 

func NewWetlandsEstablishment() *WetlandsEstablishment

func (*WetlandsEstablishment) WithDissolvedNitrogenRemovalEfficiency 

func (w *WetlandsEstablishment) WithDissolvedNitrogenRemovalEfficiency(removalEfficiency float64) *WetlandsEstablishment

func (*WetlandsEstablishment) WithImplementationCost 

func (w *WetlandsEstablishment) WithImplementationCost(costInDollars float64) *WetlandsEstablishment

func (*WetlandsEstablishment) WithOpportunityCost 

func (w *WetlandsEstablishment) WithOpportunityCost(costInDollars float64) *WetlandsEstablishment

func (*WetlandsEstablishment) WithParticulateNitrogenRemovalEfficiency 

func (w *WetlandsEstablishment) WithParticulateNitrogenRemovalEfficiency(removalEfficiency float64) *WetlandsEstablishment

func (*WetlandsEstablishment) WithPlanningUnit 

func (w *WetlandsEstablishment) WithPlanningUnit(planningUnit planningunit.Id) *WetlandsEstablishment

func (*WetlandsEstablishment) WithSedimentRemovalEfficiency 

func (w *WetlandsEstablishment) WithSedimentRemovalEfficiency(removalEfficiency float64) *WetlandsEstablishment

func (*WetlandsEstablishment) WithType 

func (w *WetlandsEstablishment) WithType(actionType action.ManagementActionType) *WetlandsEstablishment

func (*WetlandsEstablishment) WithVariable 

func (w *WetlandsEstablishment) WithVariable(variableName action.ModelVariableName, value float64) *WetlandsEstablishment

type WetlandsEstablishmentGroup 

type WetlandsEstablishmentGroup struct {
	Container
	// contains filtered or unexported fields
}

func (*WetlandsEstablishmentGroup) ManagementActions 

func (w *WetlandsEstablishmentGroup) ManagementActions() []action.ManagementAction

func (*WetlandsEstablishmentGroup) WithActionsTable 

func (w *WetlandsEstablishmentGroup) WithActionsTable(parentSoilsTable tables.CsvTable) *WetlandsEstablishmentGroup

func (*WetlandsEstablishmentGroup) WithParameters 

func (w *WetlandsEstablishmentGroup) WithParameters(parameters parameters.Parameters) *WetlandsEstablishmentGroup

func (*WetlandsEstablishmentGroup) WithPlanningUnitTable 

func (w *WetlandsEstablishmentGroup) WithPlanningUnitTable(planningUnitTable tables.CsvTable) *WetlandsEstablishmentGroup

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.