IntegralPreservingFunctionIC

Function initial condition that preserves an integral

Description

Sets an initial condition while preserving an integral. The "function" is used to specify the overall "form" of the initial condition, such that the applied initial condition is

$(1)var element = document.getElementById("moose-equation-5651578f-dc07-482a-9159-a00b0f0726f5");katex.render(" u(\\vec{r}, t_0) = q_0 f(\\vec{r}, t_0)", element, {displayMode:true,throwOnError:false});$

where $var element = document.getElementById("moose-equation-165547e9-53a2-4981-8848-0524f2d691fb");katex.render("u", element, {displayMode:false,throwOnError:false});$ is the variable, $var element = document.getElementById("moose-equation-a8483743-4e2e-4ecf-8d19-e7143d9967bc");katex.render("f", element, {displayMode:false,throwOnError:false});$ is the function, and $var element = document.getElementById("moose-equation-f7f3caa6-e611-465d-b07f-7e72cb1f0ba0");katex.render("q_0", element, {displayMode:false,throwOnError:false});$ is a scaling factor used to preserve a total "magnitude" upon volume integration:

$(2)var element = document.getElementById("moose-equation-d16a592a-2d8b-4dd2-9254-71a1fee5159b");katex.render(" q_0=\\frac{Q}{\\int_\\Omega fd\\Omega}", element, {displayMode:true,throwOnError:false});$

where $var element = document.getElementById("moose-equation-3b72a3db-5d94-4546-9ca0-5f61fd2b10e9");katex.render("Q", element, {displayMode:false,throwOnError:false});$ is the total magnitude and $var element = document.getElementById("moose-equation-d642815b-a273-451b-be2d-d1a6fb47f00a");katex.render("\\Omega", element, {displayMode:false,throwOnError:false});$ is the domain of integration.

Example Input Syntax

As an example, below we set a sinusoidal heat source with generic form $var element = document.getElementById("moose-equation-0e994885-c42d-44c0-9b75-4c12b3c9a3c7");katex.render("\\sin{\\left(\\frac{\\pi z}{H}\\right)}", element, {displayMode:false,throwOnError:false});$ for a total magnitude of 550 (upon volume integration). This means that the actual initial condition is $var element = document.getElementById("moose-equation-d245189e-78b8-40dd-b032-131b82528720");katex.render("q_0\\sin{\\left(\\frac{\\pi z}{H}\\right)}", element, {displayMode:false,throwOnError:false});$ , where $var element = document.getElementById("moose-equation-3b68b87a-af17-4f2e-99cf-c1f1d29a686b");katex.render("q_0", element, {displayMode:false,throwOnError:false});$ is determined in order to satisfy the specified total volume integral.

[ICs]
  [power]
    type = IntegralPreservingFunctionIC
    variable = power
    magnitude = 550.0
    function = 'sin(pi * z / 1.9)'
    integral = vol
  []
[]

[Postprocessors]
  [vol]
    type = FunctionElementIntegral
    function = 'sin(pi * z / 1.9)'
    execute_on = 'initial'
  []
  [integrated_power] # should equal 550
    type = ElementIntegralVariablePostprocessor
    variable = power
  []
[]

Input Parameters

functionThe initial condition function.
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:The initial condition function.
integralPostprocessor providing the integral of the function, for normalization
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:Postprocessor providing the integral of the function, for normalization
magnitudeDesired magnitude of the initial condition upon integration
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Desired magnitude of the initial condition upon integration
variableThe variable this initial condition is supposed to provide values for.
C++ Type:VariableName
Unit:(no unit assumed)
Controllable:No
Description:The variable this initial condition is supposed to provide values for.

Required Parameters

blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
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>
Unit:(no unit assumed)
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
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.
scaling_factor1Scaling factor to apply on the function
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Scaling factor to apply on the function
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
Unit:(no unit assumed)
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.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:No
Description:Set the enabled status of the MooseObject.
ignore_uo_dependencyFalseWhen set to true, a UserObject retrieved by this IC will not be executed before the this IC
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:When set to true, a UserObject retrieved by this IC will not be executed before the this IC

Advanced Parameters

(moose/test/tests/ics/integral_preserving_function_ic/sinusoidal_z.i)

[Mesh]
  type = GeneratedMesh
  dim = 3
  nx = 5
  ny = 5
  nz = 20
  xmax = 1.5
  ymax = 1.7
  zmax = 1.9
  xmin = 0.0
  ymin = 0.0
  zmin = 0.0
[]

[Problem]
  type = FEProblem
  solve = false
[]

[AuxVariables]
  [power]
    family = MONOMIAL
    order = CONSTANT
  []
[]

[ICs]
  [power]
    type = IntegralPreservingFunctionIC
    variable = power
    magnitude = 550.0
    function = 'sin(pi * z / 1.9)'
    integral = vol
  []
[]

[Postprocessors]
  [vol]
    type = FunctionElementIntegral
    function = 'sin(pi * z / 1.9)'
    execute_on = 'initial'
  []
  [integrated_power] # should equal 550
    type = ElementIntegralVariablePostprocessor
    variable = power
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

Description
Example Input Syntax
Input Parameters