PTGeothermal

buildconstruction:Undocumented Class

The PTGeothermal has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Overview

Example Input File Syntax

Input Parameters

  • blockThe list of blocks (ids or names) that this object will be applied

    C++ Type:std::vector<SubdomainName>

    Controllable:No

    Description:The list of blocks (ids or names) that this object will be applied

  • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:The list of boundaries (ids or names) from the mesh where this object applies

  • compressibility1e-05Total compressibility of the researvoir, default = 1.0e-5

    Default:1e-05

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Total compressibility of the researvoir, default = 1.0e-5

  • computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

    Default:True

    C++ Type:bool

    Controllable:No

    Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.

  • constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

    Default:NONE

    C++ Type:MooseEnum

    Options:NONE, ELEMENT, SUBDOMAIN

    Controllable:No

    Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped

  • constant_pressure_gradient0 0 0Constant pressure gradient, default = '0 0 0'

    Default:0 0 0

    C++ Type:libMesh::VectorValue<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:Constant pressure gradient, default = '0 0 0'

  • csv_density_rockAssign aux variable for rock density [kg/m^3] read from a CSV file

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:Assign aux variable for rock density [kg/m^3] read from a CSV file

  • csv_permeabilityAssign aux variable for permeability [m2] read from a CSV file

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:Assign aux variable for permeability [m2] read from a CSV file

  • csv_porosityAssign aux variable for porosity read from a CSV file

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:Assign aux variable for porosity read from a CSV file

  • csv_specific_heat_rockAssign aux variable for specific heat of the rock [J/(kg.K)] read from a CSV file

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:Assign aux variable for specific heat of the rock [J/(kg.K)] read from a CSV file

  • csv_thermal_conductivityAssign aux variable for thermal conductivity of the reservoir [W/(m.K)] read from a CSV file

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:Assign aux variable for thermal conductivity of the reservoir [W/(m.K)] read from a CSV file

  • declare_suffixAn optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:An optional suffix parameter that can be appended to any declared properties. The suffix will be prepended with a '_' character.

  • density_rock2500Rock density [kg/m^3]

    Default:2500

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Rock density [kg/m^3]

  • density_water1000Initial water density [kg/m^3], default = 1000

    Default:1000

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Initial water density [kg/m^3], default = 1000

  • fitting_parameter10Fitting parameter, default = 10

    Default:10

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Fitting parameter, default = 10

  • fluid_property_formulationconstantFluid property formulation, default = constant

    Default:constant

    C++ Type:MooseEnum

    Options:constant, compressibility, wseos

    Controllable:No

    Description:Fluid property formulation, default = constant

  • gravity9.80665Gravity acceleration constant [m/s^2], default = 9.80665

    Default:9.80665

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Gravity acceleration constant [m/s^2], default = 9.80665

  • gravity_direction0 0 -1Gravity unit directional vector, default = '0 0 -1'

    Default:0 0 -1

    C++ Type:libMesh::VectorValue<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:Gravity unit directional vector, default = '0 0 -1'

  • initial_fluid_pressure0Initial fluid pressure [Pa], default = 0

    Default:0

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Initial fluid pressure [Pa], default = 0

  • permeability1e-12Intrinsic permeability [m^2], default = 1.0e-12

    Default:1e-12

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Intrinsic permeability [m^2], default = 1.0e-12

  • permeability_function_typeconstantType for permeability function, default = constant

    Default:constant

    C++ Type:MooseEnum

    Options:constant, 1, 2

    Controllable:No

    Description:Type for permeability function, default = constant

  • porosity0.3Rock porosity, default = 0.3

    Default:0.3

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Rock porosity, default = 0.3

  • pressureAssign nonlinear variable for pressure [Pa], if mass balance is involved

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:Assign nonlinear variable for pressure [Pa], if mass balance is involved

  • reference_pressure101325Reference pressure [Pa], default = 101325

    Default:101325

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Reference pressure [Pa], default = 101325

  • reference_temperature297.15Reference temperature [K], default = 297.15

    Default:297.15

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Reference temperature [K], default = 297.15

  • specific_heat_rock920Specific heat of the rock [J/(kg.K)], default = 0.92e3

    Default:920

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Specific heat of the rock [J/(kg.K)], default = 0.92e3

  • specific_heat_water4186Specific heat of water [J/(kg.K)], default = 4.186e3

    Default:4186

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Specific heat of water [J/(kg.K)], default = 4.186e3

  • stabilizernoneEnergy transport stabilizer, default = none

    Default:none

    C++ Type:MooseEnum

    Options:none, zero, supg, supg_dc

    Controllable:No

    Description:Energy transport stabilizer, default = none

  • stochastic_permeabilityAssign aux variable for stochastic permeability [m2]

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:Assign aux variable for stochastic permeability [m2]

  • supg_dc_threshold1e-12Threshold magnitude of temperature gradient to include SUPG discontinuity capturing, default = 1e-12

    Default:1e-12

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Threshold magnitude of temperature gradient to include SUPG discontinuity capturing, default = 1e-12

  • temperatureAssign nonlinear variable for temperature [K], if energy balance is involved

    C++ Type:std::vector<VariableName>

    Unit:(no unit assumed)

    Controllable:No

    Description:Assign nonlinear variable for temperature [K], if energy balance is involved

  • thermal_conductivity2.5Thermal conductivity of the reservoir [W/(m.K)], default = 2.5

    Default:2.5

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Thermal conductivity of the reservoir [W/(m.K)], default = 2.5

  • total_overburden_confining_pressure4.5e+07Total overburden confining pressure [Pa], default = 45000000

    Default:4.5e+07

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Total overburden confining pressure [Pa], default = 45000000

  • viscosity_water0.001Initial water viscosity [Pa.s], default = 0.001

    Default:0.001

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Initial water viscosity [Pa.s], default = 0.001

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:The seed for the master random number generator

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

  • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

    Default:none

    C++ Type:std::vector<OutputName>

    Controllable:No

    Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

Outputs Parameters

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Material Property Retrieval Parameters

Input Files