MFEMComplexPointVariableValueSampler

Overview

This class performs interpolation of complex scalar and vector quantities at a set of specified points using MFEM's FindPointsGSLIB gslib interpolation. The real and imaginary parts of each sampled component are output as separate columns.

Example Input File Syntax

[VectorPostprocessors<<<{"href": "../../../syntax/VectorPostprocessors/index.html"}>>>]
  [complex_state_sample]
    type = MFEMComplexPointVariableValueSampler<<<{"description": "Sample a complex MFEM variable at specific points, outputting real and imaginary parts as separate columns.", "href": "MFEMComplexPointVariableValueSampler.html"}>>>
    variable<<<{"description": "The variable that this VectorPostprocessor samples"}>>> = complex_state
    points<<<{"description": "The points where you want to evaluate the variable"}>>> = '2.125 0 -1.375'
    execute_on<<<{"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."}>>> = TIMESTEP_END
  []
[]
(test/tests/mfem/variables/complex_aux_recovery.i)

Input Parameters

  • pointsThe points where you want to evaluate the variable

    C++ Type:std::vector<libMesh::Point>

    Controllable:No

    Description:The points where you want to evaluate the variable

  • variableThe variable that this VectorPostprocessor samples

    C++ Type:VariableName

    Unit:(no unit assumed)

    Controllable:No

    Description:The variable that this VectorPostprocessor samples

Required Parameters

  • contains_complete_historyFalseSet this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Set this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation

  • 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_CONVERGENCE, 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.

  • mesh_boundary_tolerance1e-08Distance from point to mesh boundary below which the point is considered to be on the boundary rather than outside the mesh.

    Default:1e-08

    C++ Type:Real

    Unit:(no unit assumed)

    Controllable:No

    Description:Distance from point to mesh boundary below which the point is considered to be on the boundary rather than outside the mesh.

  • parallel_typeREPLICATEDSet how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.

    Default:REPLICATED

    C++ Type:MooseEnum

    Options:DISTRIBUTED, REPLICATED

    Controllable:No

    Description:Set how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.

  • point_orderingVDIMOrdering style to use for point vector DoFs.

    Default:VDIM

    C++ Type:MooseEnum

    Options:NODES, VDIM

    Controllable:No

    Description:Ordering style to use for point vector DoFs.

  • side_interpolation_typeARITHMETICAverage type used when sampling L2 functions at element boundaries.

    Default:ARITHMETIC

    C++ Type:MooseEnum

    Options:NONE, ARITHMETIC, HARMONIC

    Controllable:No

    Description:Average type used when sampling L2 functions at element boundaries.

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.

  • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

    C++ Type:std::vector<OutputName>

    Controllable:No

    Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

Advanced Parameters

Input Files