FunctorNodalCorrector

Set (all or some) values of (one or more) nonlinear variable(s) using functor evaluations

Design

The FunctorNodalCorrector is derived from the NodalUserObject, so it can change primary variable values for degrees of freedom located on nodes (boundary-restricted if desired).

note

Except for constant monomials, Lagrange variable, and other simple FE families, simply setting variable DOFs using targeted evaluations may not give the expected result of a variable following closely the functor values over the domain of interest.

Input Parameters

functorsFunctors to compute the new variable values with. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.
C++ Type:std::vector<MooseFunctorName>
Unit:(no unit assumed)
Controllable:No
Description:Functors to compute the new variable values with. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.
variables_to_correctVariables to change the value of.
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:Variables to change the value of.

Required Parameters

blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
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>
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
excluded_nodesetsVector of nodesets to skip execution on
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:Vector of nodesets to skip execution on
functor_evaluation_techniquenode_argHow to evaluate the functor
Default:node_arg
C++ Type:MooseEnum
Options:node_arg
Controllable:No
Description:How to evaluate the functor

Optional Parameters

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
Controllable:No
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).
execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Options:XFEM_MARK, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, MULTISYSTEM_FIXED_POINT_ITERATION_END, FINAL, CUSTOM, TRANSFER
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup

Execution Scheduling Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
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
Controllable:Yes
Description:Set the enabled status of the MooseObject.
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Controllable:No
Description:The seed for the master random number generator
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
Controllable:No
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

(test/tests/correctors/nodal_functor/test.i)

References

No citations exist within this document.

(test/tests/correctors/nodal_functor/test.i)

[Mesh]
  [cmg]
    type = CartesianMeshGenerator
    dim = 1
    dx = 2
    ix = 2
  []
[]

[Variables]
  [u]
  []
[]

[Problem]
  kernel_coverage_check = false
[]

[Functions]
  [setter]
    type = ParsedFunction
    expression = '2 + x + 10 * t'
  []
[]

[Correctors]
  [corr]
    type = FunctorNodalCorrector
    variables_to_correct = u
    functors = 'setter'
    execution_order_group = -1
  []
[]

[Executioner]
  type = Transient
  num_steps = 4
[]

[Postprocessors]
  [min_u]
    type = NodalExtremeValue
    value_type = 'min'
    variable = 'u'
  []
  [max_u]
    type = NodalExtremeValue
    value_type = 'max'
    variable = 'u'
  []
[]

[Outputs]
  csv = true
[]

Design
Input Parameters
Input Files
References