Documentation ¶
Index ¶
- Constants
- func LumpedConstituentTransport(inflowLoads, lateralLoads, outflows, storage data.ND1Float64, ...) (storedMass float64)
- type ConstituentDecay
- func (m *ConstituentDecay) ApplyParameters(parameters data.ND2Float64)
- func (m *ConstituentDecay) Description() sim.ModelDescription
- func (m *ConstituentDecay) FindDimensions(parameters data.ND2Float64) []int
- func (m *ConstituentDecay) InitialiseDimensions(dims []int)
- func (m *ConstituentDecay) InitialiseStates(n int) data.ND2Float64
- func (m *ConstituentDecay) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
- type InstreamCoarseSediment
- func (m *InstreamCoarseSediment) ApplyParameters(parameters data.ND2Float64)
- func (m *InstreamCoarseSediment) Description() sim.ModelDescription
- func (m *InstreamCoarseSediment) FindDimensions(parameters data.ND2Float64) []int
- func (m *InstreamCoarseSediment) InitialiseDimensions(dims []int)
- func (m *InstreamCoarseSediment) InitialiseStates(n int) data.ND2Float64
- func (m *InstreamCoarseSediment) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
- type InstreamDissolvedNutrientDecay
- func (m *InstreamDissolvedNutrientDecay) ApplyParameters(parameters data.ND2Float64)
- func (m *InstreamDissolvedNutrientDecay) Description() sim.ModelDescription
- func (m *InstreamDissolvedNutrientDecay) FindDimensions(parameters data.ND2Float64) []int
- func (m *InstreamDissolvedNutrientDecay) InitialiseDimensions(dims []int)
- func (m *InstreamDissolvedNutrientDecay) InitialiseStates(n int) data.ND2Float64
- func (m *InstreamDissolvedNutrientDecay) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
- type InstreamFineSediment
- func (m *InstreamFineSediment) ApplyParameters(parameters data.ND2Float64)
- func (m *InstreamFineSediment) Description() sim.ModelDescription
- func (m *InstreamFineSediment) FindDimensions(parameters data.ND2Float64) []int
- func (m *InstreamFineSediment) InitialiseDimensions(dims []int)
- func (m *InstreamFineSediment) InitialiseStates(n int) data.ND2Float64
- func (m *InstreamFineSediment) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
- type InstreamParticulateNutrient
- func (m *InstreamParticulateNutrient) ApplyParameters(parameters data.ND2Float64)
- func (m *InstreamParticulateNutrient) Description() sim.ModelDescription
- func (m *InstreamParticulateNutrient) FindDimensions(parameters data.ND2Float64) []int
- func (m *InstreamParticulateNutrient) InitialiseDimensions(dims []int)
- func (m *InstreamParticulateNutrient) InitialiseStates(n int) data.ND2Float64
- func (m *InstreamParticulateNutrient) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
- type Lag
- func (m *Lag) ApplyParameters(parameters data.ND2Float64)
- func (m *Lag) Description() sim.ModelDescription
- func (m *Lag) FindDimensions(parameters data.ND2Float64) []int
- func (m *Lag) InitialiseDimensions(dims []int)
- func (m *Lag) InitialiseStates(n int) data.ND2Float64
- func (m *Lag) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
- type LumpedConstituentRouting
- func (m *LumpedConstituentRouting) ApplyParameters(parameters data.ND2Float64)
- func (m *LumpedConstituentRouting) Description() sim.ModelDescription
- func (m *LumpedConstituentRouting) FindDimensions(parameters data.ND2Float64) []int
- func (m *LumpedConstituentRouting) InitialiseDimensions(dims []int)
- func (m *LumpedConstituentRouting) InitialiseStates(n int) data.ND2Float64
- func (m *LumpedConstituentRouting) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
- type Muskingum
- func (m *Muskingum) ApplyParameters(parameters data.ND2Float64)
- func (m *Muskingum) Description() sim.ModelDescription
- func (m *Muskingum) FindDimensions(parameters data.ND2Float64) []int
- func (m *Muskingum) InitialiseDimensions(dims []int)
- func (m *Muskingum) InitialiseStates(n int) data.ND2Float64
- func (m *Muskingum) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
- type StorageRouting
- func (m *StorageRouting) ApplyParameters(parameters data.ND2Float64)
- func (m *StorageRouting) Description() sim.ModelDescription
- func (m *StorageRouting) FindDimensions(parameters data.ND2Float64) []int
- func (m *StorageRouting) InitialiseDimensions(dims []int)
- func (m *StorageRouting) InitialiseStates(n int) data.ND2Float64
- func (m *StorageRouting) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
Constants ¶
View Source
const MINIMUM_VOLUME = 1e-2
Variables ¶
This section is empty.
Functions ¶
func LumpedConstituentTransport ¶
func LumpedConstituentTransport(inflowLoads, lateralLoads, outflows, storage data.ND1Float64, initialStoredMass float64, x, pointInput, deltaT float64, outflowLoads, pointSourceLoad data.ND1Float64) (storedMass float64)
Types ¶
type ConstituentDecay ¶
type ConstituentDecay struct { X data.ND1Float64 DeltaT data.ND1Float64 // contains filtered or unexported fields }
func (*ConstituentDecay) ApplyParameters ¶
func (m *ConstituentDecay) ApplyParameters(parameters data.ND2Float64)
func (*ConstituentDecay) Description ¶
func (m *ConstituentDecay) Description() sim.ModelDescription
func (*ConstituentDecay) FindDimensions ¶
func (m *ConstituentDecay) FindDimensions(parameters data.ND2Float64) []int
func (*ConstituentDecay) InitialiseDimensions ¶
func (m *ConstituentDecay) InitialiseDimensions(dims []int)
func (*ConstituentDecay) InitialiseStates ¶
func (m *ConstituentDecay) InitialiseStates(n int) data.ND2Float64
func (*ConstituentDecay) Run ¶
func (m *ConstituentDecay) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
type InstreamCoarseSediment ¶
type InstreamCoarseSediment struct {
// contains filtered or unexported fields
}
func (*InstreamCoarseSediment) ApplyParameters ¶
func (m *InstreamCoarseSediment) ApplyParameters(parameters data.ND2Float64)
func (*InstreamCoarseSediment) Description ¶
func (m *InstreamCoarseSediment) Description() sim.ModelDescription
func (*InstreamCoarseSediment) FindDimensions ¶
func (m *InstreamCoarseSediment) FindDimensions(parameters data.ND2Float64) []int
func (*InstreamCoarseSediment) InitialiseDimensions ¶
func (m *InstreamCoarseSediment) InitialiseDimensions(dims []int)
func (*InstreamCoarseSediment) InitialiseStates ¶
func (m *InstreamCoarseSediment) InitialiseStates(n int) data.ND2Float64
func (*InstreamCoarseSediment) Run ¶
func (m *InstreamCoarseSediment) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
type InstreamDissolvedNutrientDecay ¶
type InstreamDissolvedNutrientDecay struct {
// contains filtered or unexported fields
}
func (*InstreamDissolvedNutrientDecay) ApplyParameters ¶
func (m *InstreamDissolvedNutrientDecay) ApplyParameters(parameters data.ND2Float64)
func (*InstreamDissolvedNutrientDecay) Description ¶
func (m *InstreamDissolvedNutrientDecay) Description() sim.ModelDescription
func (*InstreamDissolvedNutrientDecay) FindDimensions ¶
func (m *InstreamDissolvedNutrientDecay) FindDimensions(parameters data.ND2Float64) []int
func (*InstreamDissolvedNutrientDecay) InitialiseDimensions ¶
func (m *InstreamDissolvedNutrientDecay) InitialiseDimensions(dims []int)
func (*InstreamDissolvedNutrientDecay) InitialiseStates ¶
func (m *InstreamDissolvedNutrientDecay) InitialiseStates(n int) data.ND2Float64
func (*InstreamDissolvedNutrientDecay) Run ¶
func (m *InstreamDissolvedNutrientDecay) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
type InstreamFineSediment ¶
type InstreamFineSediment struct {
// contains filtered or unexported fields
}
func (*InstreamFineSediment) ApplyParameters ¶
func (m *InstreamFineSediment) ApplyParameters(parameters data.ND2Float64)
func (*InstreamFineSediment) Description ¶
func (m *InstreamFineSediment) Description() sim.ModelDescription
func (*InstreamFineSediment) FindDimensions ¶
func (m *InstreamFineSediment) FindDimensions(parameters data.ND2Float64) []int
func (*InstreamFineSediment) InitialiseDimensions ¶
func (m *InstreamFineSediment) InitialiseDimensions(dims []int)
func (*InstreamFineSediment) InitialiseStates ¶
func (m *InstreamFineSediment) InitialiseStates(n int) data.ND2Float64
func (*InstreamFineSediment) Run ¶
func (m *InstreamFineSediment) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
type InstreamParticulateNutrient ¶
type InstreamParticulateNutrient struct {
// contains filtered or unexported fields
}
func (*InstreamParticulateNutrient) ApplyParameters ¶
func (m *InstreamParticulateNutrient) ApplyParameters(parameters data.ND2Float64)
func (*InstreamParticulateNutrient) Description ¶
func (m *InstreamParticulateNutrient) Description() sim.ModelDescription
func (*InstreamParticulateNutrient) FindDimensions ¶
func (m *InstreamParticulateNutrient) FindDimensions(parameters data.ND2Float64) []int
func (*InstreamParticulateNutrient) InitialiseDimensions ¶
func (m *InstreamParticulateNutrient) InitialiseDimensions(dims []int)
func (*InstreamParticulateNutrient) InitialiseStates ¶
func (m *InstreamParticulateNutrient) InitialiseStates(n int) data.ND2Float64
func (*InstreamParticulateNutrient) Run ¶
func (m *InstreamParticulateNutrient) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
type Lag ¶
type Lag struct {
// contains filtered or unexported fields
}
func (*Lag) ApplyParameters ¶
func (m *Lag) ApplyParameters(parameters data.ND2Float64)
func (*Lag) Description ¶
func (m *Lag) Description() sim.ModelDescription
func (*Lag) FindDimensions ¶
func (m *Lag) FindDimensions(parameters data.ND2Float64) []int
func (*Lag) InitialiseDimensions ¶
func (*Lag) InitialiseStates ¶
func (m *Lag) InitialiseStates(n int) data.ND2Float64
func (*Lag) Run ¶
func (m *Lag) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
type LumpedConstituentRouting ¶
type LumpedConstituentRouting struct { X data.ND1Float64 DeltaT data.ND1Float64 // contains filtered or unexported fields }
func (*LumpedConstituentRouting) ApplyParameters ¶
func (m *LumpedConstituentRouting) ApplyParameters(parameters data.ND2Float64)
func (*LumpedConstituentRouting) Description ¶
func (m *LumpedConstituentRouting) Description() sim.ModelDescription
func (*LumpedConstituentRouting) FindDimensions ¶
func (m *LumpedConstituentRouting) FindDimensions(parameters data.ND2Float64) []int
func (*LumpedConstituentRouting) InitialiseDimensions ¶
func (m *LumpedConstituentRouting) InitialiseDimensions(dims []int)
func (*LumpedConstituentRouting) InitialiseStates ¶
func (m *LumpedConstituentRouting) InitialiseStates(n int) data.ND2Float64
func (*LumpedConstituentRouting) Run ¶
func (m *LumpedConstituentRouting) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
type Muskingum ¶
type Muskingum struct { K data.ND1Float64 X data.ND1Float64 DeltaT data.ND1Float64 }
func (*Muskingum) ApplyParameters ¶
func (m *Muskingum) ApplyParameters(parameters data.ND2Float64)
func (*Muskingum) Description ¶
func (m *Muskingum) Description() sim.ModelDescription
func (*Muskingum) FindDimensions ¶
func (m *Muskingum) FindDimensions(parameters data.ND2Float64) []int
func (*Muskingum) InitialiseDimensions ¶
func (*Muskingum) InitialiseStates ¶
func (m *Muskingum) InitialiseStates(n int) data.ND2Float64
func (*Muskingum) Run ¶
func (m *Muskingum) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
type StorageRouting ¶
type StorageRouting struct { InflowBias data.ND1Float64 RoutingConstant data.ND1Float64 RoutingPower data.ND1Float64 DeltaT data.ND1Float64 // contains filtered or unexported fields }
func (*StorageRouting) ApplyParameters ¶
func (m *StorageRouting) ApplyParameters(parameters data.ND2Float64)
func (*StorageRouting) Description ¶
func (m *StorageRouting) Description() sim.ModelDescription
func (*StorageRouting) FindDimensions ¶
func (m *StorageRouting) FindDimensions(parameters data.ND2Float64) []int
func (*StorageRouting) InitialiseDimensions ¶
func (m *StorageRouting) InitialiseDimensions(dims []int)
func (*StorageRouting) InitialiseStates ¶
func (m *StorageRouting) InitialiseStates(n int) data.ND2Float64
func (*StorageRouting) Run ¶
func (m *StorageRouting) Run(inputs data.ND3Float64, states data.ND2Float64, outputs data.ND3Float64)
Source Files ¶
- decay.go
- generated_ConstituentDecay.go
- generated_InstreamCoarseSediment.go
- generated_InstreamDissolvedNutrientDecay.go
- generated_InstreamFineSediment.go
- generated_InstreamParticulateNutrient.go
- generated_Lag.go
- generated_LumpedConstituentRouting.go
- generated_Muskingum.go
- generated_StorageRouting.go
- instream_coarse_sediment.go
- instream_dissolved_nutrient.go
- instream_fine_sediment.go
- instream_particulate_nutrient.go
- lag.go
- lumpedconstituent.go
- muskingum.go
- storage_routing.go
Click to show internal directories.
Click to hide internal directories.