rs2.modeler.properties.material.hydraulic.FEAGroundwater package

rs2.modeler.properties.material.hydraulic.FEAGroundwater.Brooks module

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Brooks.BrooksStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getBubblingPressureFactor() → float

getPoreSizeIndexFactor() → float

getKsFactor() → float

getWCSatFactor() → float

getWCResFactor() → float

getDoSSatFactor() → float

getDoSResFactor() → float

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Brooks.BrooksDefinedStageFactor(client: Client, ID, propertyID)

Bases: BrooksStageFactor

setBubblingPressureFactor(value: float)

setPoreSizeIndexFactor(value: float)

setKsFactor(value: float)

setWCSatFactor(value: float)

setWCResFactor(value: float)

setDoSSatFactor(value: float)

setDoSResFactor(value: float)

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Brooks.Brooks(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Hydraulic FEA Groundwater Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[BrooksDefinedStageFactor, BrooksStageFactor]

getPoreSizeIndex() → float

setPoreSizeIndex(value: float)

getBubblingPressure() → float

setBubblingPressure(value: float)

getKs() → float

setKs(value: float)

getWCInputType() → WCInputType

setWCInputType(value: WCInputType)

getWCSat() → float

setWCSat(value: float)

getWCRes() → float

setWCRes(value: float)

getDoSSat() → float

setDoSSat(value: float)

getDoSRes() → float

setDoSRes(value: float)

setProperties(PoreSizeIndex: float = None, BubblingPressure: float = None, Ks: float = None, WCInputType: WCInputType = None, WCSat: float = None, WCRes: float = None, DoSSat: float = None, DoSRes: float = None)

getProperties()

rs2.modeler.properties.material.hydraulic.FEAGroundwater.Constant module

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Constant.ConstantStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getWCCurveSlopeFactor() → float

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Constant.ConstantDefinedStageFactor(client: Client, ID, propertyID)

Bases: ConstantStageFactor

setWCCurveSlopeFactor(value: float)

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Constant.Constant(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Hydraulic FEA Groundwater Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[ConstantDefinedStageFactor, ConstantStageFactor]

getUseCV() → bool

setUseCV(value: bool)

getCV() → float

setCV(value: float)

getInitialK() → float

setInitialK(value: float)

getWCCurveSlope() → float

setWCCurveSlope(value: float)

setProperties(UseCV: bool = None, CV: float = None, InitialK: float = None, WCCurveSlope: float = None)

getProperties()

rs2.modeler.properties.material.hydraulic.FEAGroundwater.FEAGroundwater module

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.FEAGroundwater.FEAGroundwaterStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getK1AngleFactor() → float

getK2K1Factor() → float

getMvFactor() → float

getAnisotropicSurfaceFactor() → str

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.FEAGroundwater.FEAGroundwaterDefinedStageFactor(client: Client, ID, propertyID)

Bases: FEAGroundwaterStageFactor

setK1AngleFactor(value: float)

setK2K1Factor(value: float)

setMvFactor(value: float)

setAnisotropicSurfaceFactor(surfaceName: str)

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.FEAGroundwater.FEAGroundwater(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Hydraulic FEA Groundwater Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[FEAGroundwaterDefinedStageFactor, FEAGroundwaterStageFactor]

Simple

Reference object for modifying property.

Type:

Simple

Fredlund

Reference object for modifying property.

Type:

Fredlund

Genuchten

Reference object for modifying property.

Type:

Genuchten

Brooks

Reference object for modifying property.

Type:

Brooks

Gardner

Reference object for modifying property.

Type:

Gardner

Constant

Reference object for modifying property.

Type:

Constant

UserDefined

Reference object for modifying property.

Type:

UserDefined

getModel() → GroundWaterModes

setModel(value: GroundWaterModes)

getK2K1() → float

setK2K1(value: float)

getK1Definition() → AnisotropyDefinitions

setK1Definition(value: AnisotropyDefinitions)

getK1Angle() → float

setK1Angle(value: float)

getMvModel() → MVModel

setMvModel(value: MVModel)

getMv() → float

setMv(value: float)

setK1SurfaceToUseByName(surfaceName: str)

surfaceName is the name of the surface to be used. Surface must be present in the model.

getK1SurfaceToUse() → str

rs2.modeler.properties.material.hydraulic.FEAGroundwater.Fredlund module

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Fredlund.FredlundStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getAFactor() → float

getBFactor() → float

getCFactor() → float

getKsFactor() → float

getWCSatFactor() → float

getWCResFactor() → float

getDoSSatFactor() → float

getDoSResFactor() → float

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Fredlund.FredlundDefinedStageFactor(client: Client, ID, propertyID)

Bases: FredlundStageFactor

setAFactor(value: float)

setBFactor(value: float)

setCFactor(value: float)

setKsFactor(value: float)

setWCSatFactor(value: float)

setWCResFactor(value: float)

setDoSSatFactor(value: float)

setDoSResFactor(value: float)

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Fredlund.Fredlund(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Hydraulic FEA Groundwater Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[FredlundDefinedStageFactor, FredlundStageFactor]

getA() → float

setA(value: float)

getB() → float

setB(value: float)

getC() → float

setC(value: float)

getKs() → float

setKs(value: float)

getWCInputType() → WCInputType

setWCInputType(value: WCInputType)

getWCSat() → float

setWCSat(value: float)

getWCRes() → float

setWCRes(value: float)

getDoSSat() → float

setDoSSat(value: float)

getDoSRes() → float

setDoSRes(value: float)

setProperties(A: float = None, B: float = None, C: float = None, Ks: float = None, WCInputType: WCInputType = None, WCSat: float = None, WCRes: float = None, DoSSat: float = None, DoSRes: float = None)

getProperties()

rs2.modeler.properties.material.hydraulic.FEAGroundwater.Gardner module

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Gardner.GardnerStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getAFactor() → float

getNFactor() → float

getKsFactor() → float

getWCSatFactor() → float

getWCResFactor() → float

getDoSSatFactor() → float

getDoSResFactor() → float

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Gardner.GardnerDefinedStageFactor(client: Client, ID, propertyID)

Bases: GardnerStageFactor

setAFactor(value: float)

setNFactor(value: float)

setKsFactor(value: float)

setWCSatFactor(value: float)

setWCResFactor(value: float)

setDoSSatFactor(value: float)

setDoSResFactor(value: float)

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Gardner.Gardner(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Hydraulic FEA Groundwater Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[GardnerDefinedStageFactor, GardnerStageFactor]

getA() → float

setA(value: float)

getN() → float

setN(value: float)

getKs() → float

setKs(value: float)

getWCInputType() → WCInputType

setWCInputType(value: WCInputType)

getWCSat() → float

setWCSat(value: float)

getWCRes() → float

setWCRes(value: float)

getDoSSat() → float

setDoSSat(value: float)

getDoSRes() → float

setDoSRes(value: float)

setProperties(A: float = None, N: float = None, Ks: float = None, WCInputType: WCInputType = None, WCSat: float = None, WCRes: float = None, DoSSat: float = None, DoSRes: float = None)

getProperties()

rs2.modeler.properties.material.hydraulic.FEAGroundwater.Genuchten module

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Genuchten.GenuchtenStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getMFactor() → float

getNFactor() → float

getAlphaFactor() → float

getKsFactor() → float

getWCSatFactor() → float

getWCResFactor() → float

getDoSSatFactor() → float

getDoSResFactor() → float

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Genuchten.GenuchtenDefinedStageFactor(client: Client, ID, propertyID)

Bases: GenuchtenStageFactor

setMFactor(value: float)

setNFactor(value: float)

setAlphaFactor(value: float)

setKsFactor(value: float)

setWCSatFactor(value: float)

setWCResFactor(value: float)

setDoSSatFactor(value: float)

setDoSResFactor(value: float)

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Genuchten.Genuchten(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Hydraulic FEA Groundwater Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[GenuchtenDefinedStageFactor, GenuchtenStageFactor]

getAlpha() → float

setAlpha(value: float)

getN() → float

setN(value: float)

getCustomM() → bool

setCustomM(value: bool)

getM() → float

setM(value: float)

getKs() → float

setKs(value: float)

getWCInputType() → WCInputType

setWCInputType(value: WCInputType)

getWCSat() → float

setWCSat(value: float)

getWCRes() → float

setWCRes(value: float)

getDoSSat() → float

setDoSSat(value: float)

getDoSRes() → float

setDoSRes(value: float)

setProperties(Alpha: float = None, N: float = None, CustomM: bool = None, M: float = None, Ks: float = None, WCInputType: WCInputType = None, WCSat: float = None, WCRes: float = None, DoSSat: float = None, DoSRes: float = None)

getProperties()

rs2.modeler.properties.material.hydraulic.FEAGroundwater.Simple module

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Simple.SimpleStageFactor(client: Client, ID, propertyID)

Bases: ProxyObject

getKsFactor() → float

getWCSatFactor() → float

getWCResFactor() → float

getDoSSatFactor() → float

getDoSResFactor() → float

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Simple.SimpleDefinedStageFactor(client: Client, ID, propertyID)

Bases: SimpleStageFactor

setKsFactor(value: float)

setWCSatFactor(value: float)

setWCResFactor(value: float)

setDoSSatFactor(value: float)

setDoSResFactor(value: float)

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.Simple.Simple(client: Client, ID, documentProxyID, stageFactorInterfaceID)

Bases: PropertyProxy

Examples

Code Snippet: Manipulation of Hydraulic FEA Groundwater Properties

stageFactorInterface

Reference object for modifying stage factor property.

Type:

AbsoluteStageFactorGettersInterface[SimpleDefinedStageFactor, SimpleStageFactor]

getSoilType() → EnhancedSimpleSoilTypes

setSoilType(value: EnhancedSimpleSoilTypes)

getKs() → float

setKs(value: float)

getWCInputType() → WCInputType

setWCInputType(value: WCInputType)

getWCSat() → float

setWCSat(value: float)

getWCRes() → float

setWCRes(value: float)

getDoSSat() → float

setDoSSat(value: float)

getDoSRes() → float

setDoSRes(value: float)

setProperties(SoilType: EnhancedSimpleSoilTypes = None, Ks: float = None, WCInputType: WCInputType = None, WCSat: float = None, WCRes: float = None, DoSSat: float = None, DoSRes: float = None)

getProperties()

rs2.modeler.properties.material.hydraulic.FEAGroundwater.UserDefined module

class rs2.modeler.properties.material.hydraulic.FEAGroundwater.UserDefined.UserDefined(server: Client, ID, documentProxyID)

Bases: PropertyProxy

setUserDefinedPermeabilityAndWaterContentFunction(functionName: str)

getUserDefinedPermeabilityAndWaterContentFunction() → str