CoolantChannelUserObject

under construction:Undocumented Class

The CoolantChannelUserObject has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

CoolantChannelUserObject is used to compute coolant enthalpy to define the bulk coolant conditions

Input Parameters

  • variableThe name of the variable that this boundary condition applies to

    C++ Type:std::vector

    Description:The name of the variable that this boundary condition applies to

  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies

    C++ Type:std::vector

    Description:The list of boundary IDs from the mesh where this boundary condition applies

  • directionyThe direction of the layers.

    Default:y

    C++ Type:MooseEnum

    Description:The direction of the layers.

Required Parameters

  • axial_length0Length of cladding

    Default:0

    C++ Type:double

    Description:Length of cladding

  • output_option1option to output: 1) enthalpy, 2) temperature

    Default:1

    C++ Type:int

    Description:option to output: 1) enthalpy, 2) temperature

  • flow_areaThe flow area

    C++ Type:double

    Description:The flow area

  • linear_heat_rateLinear heat generation rate in W/m

    C++ Type:FunctionName

    Description:Linear heat generation rate in W/m

  • transient_start_time0The starting time for transient

    Default:0

    C++ Type:double

    Description:The starting time for transient

  • average_radius1When using 'average' sampling this is how the number of values both above and below the layer that will be averaged.

    Default:1

    C++ Type:unsigned int

    Description:When using 'average' sampling this is how the number of values both above and below the layer that will be averaged.

  • num_layersThe number of layers.

    C++ Type:unsigned int

    Description:The number of layers.

  • debug_outputFalseflag to turn on debug output

    Default:False

    C++ Type:bool

    Description:flag to turn on debug output

  • rod_pitch0.0126Rod pitch in meter

    Default:0.0126

    C++ Type:double

    Description:Rod pitch in meter

  • inlet_pressure15.5E6Inlet pressure in Pa

    Default:15.5E6

    C++ Type:FunctionName

    Description:Inlet pressure in Pa

  • heated_diameterThe heated diameter

    C++ Type:double

    Description:The heated diameter

  • cumulativeFalseWhen true the value in each layer is the sum of the values up to and including that layer

    Default:False

    C++ Type:bool

    Description:When true the value in each layer is the sum of the values up to and including that layer

  • sample_typedirectHow to sample the layers. 'direct' means get the value of the layer the point falls in directly (or average if that layer has no value). 'interpolate' does a linear interpolation between the two closest layers. 'average' averages the two closest layers.

    Default:direct

    C++ Type:MooseEnum

    Description:How to sample the layers. 'direct' means get the value of the layer the point falls in directly (or average if that layer has no value). 'interpolate' does a linear interpolation between the two closest layers. 'average' averages the two closest layers.

  • hydraulic_diameterThe hydraulic diameter

    C++ Type:double

    Description:The hydraulic diameter

  • rod_diameter0.01Rod diameter in meter

    Default:0.01

    C++ Type:double

    Description:Rod diameter in meter

  • axial_power_profileAxial power profile

    C++ Type:FunctionName

    Description:Axial power profile

  • heated_perimeterThe headed perimeter

    C++ Type:double

    Description:The headed perimeter

  • coolant_materialwaterThe name of the user object with fluid properties

    Default:water

    C++ Type:UserObjectName

    Description:The name of the user object with fluid properties

  • transientFalseflag to turn on transient calculation

    Default:False

    C++ Type:bool

    Description:flag to turn on transient calculation

  • execute_onINITIAL TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

    Default:INITIAL TIMESTEP_END

    C++ Type:ExecFlagEnum

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

  • inlet_massfluxInlet mass flux in kg/m^2-sec

    C++ Type:FunctionName

    Description:Inlet mass flux in kg/m^2-sec

  • heat_fluxHeat flux in W/m^2-K

    C++ Type:FunctionName

    Description:Heat flux in W/m^2-K

  • boundsThe 'bounding' positions of the layers i.e.: '0, 1.2, 3.7, 4.2' will mean 3 layers between those positions.

    C++ Type:std::vector

    Description:The 'bounding' positions of the layers i.e.: '0, 1.2, 3.7, 4.2' will mean 3 layers between those positions.

  • blockThe list of block ids (SubdomainID) that this object will be applied

    C++ Type:std::vector

    Description:The list of block ids (SubdomainID) that this object will be applied

  • inlet_qualityInlet quality

    C++ Type:FunctionName

    Description:Inlet quality

  • inlet_temperature300Inlet temperature in K

    Default:300

    C++ Type:FunctionName

    Description:Inlet temperature in K

Optional Parameters

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

    C++ Type:std::vector

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Description:Set the enabled status of the MooseObject.

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • 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

    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

Input Files

References