Struct VerticalFlowByTemperatureSettings

Settings of how temperature affects vertical flow

Inherited Members
Namespace: Fwt.HexTerrains.GeoPlasts.Data
Assembly: fwt.hexterrains.dll
Syntax
[Serializable]
public struct VerticalFlowByTemperatureSettings

Fields

BaseFlow

Base (max) value for vertical flow calculations. At ideal conditions, this is the amount of geo plast that will flow per tick.

Declaration
[Min(0)]
[Tooltip("Base (max) value for vertical flow calculations. At ideal conditions, this is the amount of geo plast that will flow per tick.")]
public float BaseFlow
Field Value
Type Description
float

FlowMultiplierCurve

Curve that defines how temperature affects vertical flow. The curve is evaluated with the cell temperature as input, and the output is a multiplier applied to the base flow. For example, layer start evaporation at Temperature = 273, with a peak at 373 degrees, then setup the curve to be MinValue = 273, MaxValue = 373, InInverted = false.
This way, the Curve multiplier to flow will be 0 at temperatures below 273, then increase as temperature rises, reaching 1 (maximum flow) at 373 degrees, and it stays at 1 for higher temperatures. IsInverted makes the curve inverted, so in the same example, if IsInverted is true, the flow will be 1 at temperatures below 273, then decrease as temperature rises, reaching 0 at 373 degrees, and it stays at 0 for higher temperatures. This is an example of water that freezes at 273 degrees and evaporates at 373 degrees, so it has maximum flow at low temperatures, and no flow at high temperatures. The curve should be designed to reflect the desired relationship between temperature and vertical flow in the simulation.

Declaration
[Tooltip("Curve that defines how temperature affects vertical flow. The curve is evaluated with the cell temperature as input, and the output is a multiplier applied to the Base Flow. \r\n\r\nFor example, layer starts evaporation at Temperature = 273, with a peak at 373 degrees, then setup the curve to be MinValue = 273, MaxValue = 373, InInverted = false. This way, the Curve multiplier to flow will be 0 at temperatures below 273, then increase as temperature rises, reaching 1 (maximum flow) at 373 degrees, and it stays at 1 for higher temperatures. IsInverted makes the curve inverted, so in the same example, if IsInverted is true, the flow will be 1 at temperatures below 273, then decrease as temperature rises, reaching 0 at 373 degrees, and it stays at 0 for higher temperatures. This is an example of water that starts freezing at 373 degrees and rises to max freezing speed at 273 degrees, so it has maximum flow at low temperatures, and no flow at high temperatures.\r\n\r\nThe curve should be designed to reflect the desired relationship between temperature and vertical flow in the simulation.")]
public ExponentialCurve FlowMultiplierCurve
Field Value
Type Description
ExponentialCurve

Properties

Default

Declaration
public static VerticalFlowByTemperatureSettings Default { get; }
Property Value
Type Description
VerticalFlowByTemperatureSettings

Extension Methods