- functionCoupled function to evaluate with values from v
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:Coupled function to evaluate with values from v
- 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.
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
- 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.
- 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.
- 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>
Unit:(no unit assumed)
Controllable:No
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>
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