CoupledValueFunctionIC

Initialize the variable from a lookup function

CoupledValueFunctionIC initializes the value of a variable with the value of a coupled MOOSE Function which is evaluated with a set of up to four coupled variable values v as its input parameters. The coupled variable values are substituted for the x,y,z, and t function variables in that order.

One example application is the use of a PiecewiseMultilinear function with a data file containing a pretabulation of dependent variable values as a function of up to four primary variable values.

This capability can be used when internal degrees of freedom, such as phase concentrations in a KKS model, need to be initialized to a good initial guess to improve the convergence of the first timestep. In the KKS case, and physical IC will be applied to the primary global alloy concentration variables, and the phase concentrations will be initialized from pretabulated data containing good approximations of the phase concentrations for each primary global alloy concentration.

Input Parameters

functionCoupled function to evaluate with values from v
C++ Type:FunctionName
Options:
Description:Coupled function to evaluate with values from v
variableThe variable this initial condition is supposed to provide values for.
C++ Type:VariableName
Options:
Description:The variable this initial condition is supposed to provide values for.

Required Parameters

blockThe list of block ids (SubdomainID) that this object will be applied
C++ Type:std::vector<SubdomainName>
Options:
Description:The list of block ids (SubdomainID) that this object will be applied
boundaryThe list of boundary IDs from the mesh where this boundary condition applies
C++ Type:std::vector<BoundaryName>
Options:
Description:The list of boundary IDs from the mesh where this boundary condition applies
vList of up to four coupled variables that are substituted for x,y,z, and t in the coupled function
C++ Type:std::vector<VariableName>
Options:
Description:List of up to four coupled variables that are substituted for x,y,z, and t in the coupled function

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
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
Options:
Description:When set to true, a UserObject retrieved by this IC will not be executed before the this IC

Advanced Parameters

Input Files

(modules/phase_field/test/tests/misc/coupled_value_function_ic.i)

References

(modules/phase_field/test/tests/misc/coupled_value_function_ic.i)

[Mesh]
  [gen]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 10
    ny = 10
  []
[]

# Here we sum up the inverses of the ICs above. This should add up to 2.0 everywhere
[Functions]
  [map]
    type = ParsedFunction
    value = 'x^2+y^3+log(z)+acos(t)'
  []
[]

[Variables]
  [out]
    [InitialCondition]
      type = CoupledValueFunctionIC
      function = map
      v = 'v1 v2 a3 a4'
    []
  []
  [v1]
    [InitialCondition]
      type = FunctionIC
      function = x^(1/2)
    []
  []
  [v2]
    [InitialCondition]
      type = FunctionIC
      function = y^(1/3)
    []
  []
[]

[AuxVariables]
  [a3]
    [InitialCondition]
      type = FunctionIC
      function = exp(1-x)
    []
  []
  [a4]
    [InitialCondition]
      type = FunctionIC
      function = cos(1-y)
    []
  []
[]

[Postprocessors]
  [out_min]
    type = ElementExtremeValue
    variable = out
    value_type = min
  []
  [out_max]
    type = ElementExtremeValue
    variable = out
    value_type = max
  []
[]

[Problem]
  solve = false
[]

[Executioner]
  type = Steady
[]

[Outputs]
  execute_on = 'FINAL'
  csv = true
[]

Input Parameters
Input Files
References

Install MOOSE

New Users

Examples and Tutorials

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access