PartialSumHeatFluxIntegral

under construction:Undocumented Class

!syntax description /UserObjects/PartialSumHeatFluxIntegral

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

  • thermal_conductivitythermal_conductivityThe name of the thermal conductivity material property that will be used

    Default:thermal_conductivity

    C++ Type:std::string

    Description:The name of the thermal conductivity material property that will be used

  • 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

  • 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.

  • sample_typeinterpolateHow 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:interpolate

    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.

  • 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.

  • execute_onTIMESTEP_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: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.

  • 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

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