- coefficientThe scalar coefficient to sample. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a number.
C++ Type:MFEMScalarCoefficientName
Controllable:No
Description:The scalar coefficient to sample. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a number.
- pointsThe points where the coefficient is evaluated.
C++ Type:std::vector<libMesh::Point>
Controllable:No
Description:The points where the coefficient is evaluated.
MFEMPointScalarCoefficientValueSampler
Overview
This vector postprocessor evaluates a real scalar MFEM coefficient at specified points. Unlike an MFEM variable, a coefficient is a function used by finite element operators and need not belong to a finite element space. The sampler therefore evaluates the coefficient directly in the owning element selected by MFEM's FindPointsGSLIB point search.
An arbitrary coefficient may be discontinuous across an element boundary, and MFEM coefficients do not provide general continuity metadata. When a sample is classified as lying on an element boundary, the sampler issues a warning and returns the value from the element selected by GSLIB. The variable sampler's side_interpolation_type arithmetic and harmonic averages do not apply to coefficients.
Quadrature-function-backed coefficients are defined only at the quadrature points configured by their quadrature rule. They cannot be evaluated at arbitrary sample points and are rejected by this sampler.
Example Input File Syntax
[VectorPostprocessors<<<{"href": "../../../syntax/VectorPostprocessors/index.html"}>>>]
[function_sample]
type = MFEMPointScalarCoefficientValueSampler<<<{"description": "Sample a real scalar MFEM coefficient at specific points.", "href": "MFEMPointScalarCoefficientValueSampler.html"}>>>
coefficient<<<{"description": "The scalar coefficient to sample. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a number."}>>> = linear_coefficient
points<<<{"description": "The points where the coefficient is evaluated."}>>> = '0.125 0.125 0
0.375 0.625 0
0.875 0.875 0'
[]
[material_sample]
type = MFEMPointScalarCoefficientValueSampler<<<{"description": "Sample a real scalar MFEM coefficient at specific points.", "href": "MFEMPointScalarCoefficientValueSampler.html"}>>>
coefficient<<<{"description": "The scalar coefficient to sample. A functor is any of the following: a variable, an MFEM material property, a function, a postprocessor or a number."}>>> = material_coefficient
points<<<{"description": "The points where the coefficient is evaluated."}>>> = '0.125 0.125 0
0.375 0.625 0
0.875 0.875 0'
[]
[]Input 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
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
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
Controllable:No
Description:Ordering style to use for point vector DoFs.
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