MFEMComplexVectorProjectionAux

Overview

AuxKernel for projecting a pair of vector coefficients onto a complex vector auxiliary variable in, e.g., or .

Both parts of the vector coefficient may optionally be scaled by a real scalar coefficient , set by the coefficient parameter, in which case is stored. As for MFEMVectorProjectionAux, declaring the scalar coefficient as a block restricted material property restricts the result to the blocks the property is defined on.

Example Input File Syntax

[AuxKernels<<<{"href": "../../../syntax/AuxKernels/index.html"}>>>]
  [complex_scale_by_function]
    type = MFEMComplexVectorProjectionAux<<<{"description": "Projects a real and imaginary vector coefficient, optionally scaled by a real scalar coefficient, onto a complex vector MFEM auxvariable.", "href": "MFEMComplexVectorProjectionAux.html"}>>>
    variable<<<{"description": "The name of the variable that this object applies to"}>>> = complex_function_scaled
    vector_coefficient_real<<<{"description": "Name of the real part of the vector coefficient to project. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a numeric vector value (enclosed in curly braces)."}>>> = source_field
    vector_coefficient_imag<<<{"description": "Name of the imaginary part of the vector coefficient to project. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a numeric vector value (enclosed in curly braces)."}>>> = imag_source
    coefficient<<<{"description": "Name of the real scalar coefficient k to scale both parts of the vector coefficient by. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a number."}>>> = ramp
  []
[]
(test/tests/mfem/auxkernels/scaledvector.i)

Input Parameters

  • variableThe name of the variable that this object applies to

    C++ Type:AuxVariableName

    Unit:(no unit assumed)

    Controllable:No

    Description:The name of the variable that this object applies to

  • vector_coefficient_imagName of the imaginary part of the vector coefficient to project. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a numeric vector value (enclosed in curly braces).

    C++ Type:MFEMVectorCoefficientName

    Controllable:No

    Description:Name of the imaginary part of the vector coefficient to project. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a numeric vector value (enclosed in curly braces).

  • vector_coefficient_realName of the real part of the vector coefficient to project. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a numeric vector value (enclosed in curly braces).

    C++ Type:MFEMVectorCoefficientName

    Controllable:No

    Description:Name of the real part of the vector coefficient to project. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a numeric vector value (enclosed in curly braces).

Required Parameters

  • coefficient1.Name of the real scalar coefficient k to scale both parts of the vector coefficient by. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a number.

    Default:1.

    C++ Type:MFEMScalarCoefficientName

    Controllable:No

    Description:Name of the real scalar coefficient k to scale both parts of the vector coefficient by. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a number.

  • 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

    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.

Optional 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:No

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Files