MFEMComplexVariableLineValueSampler

Overview

This class performs interpolation of complex scalar and vector variables along a specified line 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"}>>>]
  [line_sample]
    type = MFEMComplexVariableLineValueSampler<<<{"description": "Sample a complex MFEM variable along a specified line, outputting real and imaginary parts as separate columns.", "href": "MFEMComplexVariableLineValueSampler.html"}>>>
    variable<<<{"description": "The variable that this VectorPostprocessor samples"}>>> = 'u'
    start_point<<<{"description": "The beginning of the line"}>>> = '0 0 0'
    end_point<<<{"description": "The ending of the line"}>>> = '1 1 0'
    num_points<<<{"description": "The number of points to sample along the line"}>>> = 101
  []
[]

Input Parameters

end_pointThe ending of the line
C++ Type:libMesh::Point
Controllable:No
Description:The ending of the line
num_pointsThe number of points to sample along the line
C++ Type:unsigned int
Range:num_points >= 2
Controllable:No
Description:The number of points to sample along the line
start_pointThe beginning of the line
C++ Type:libMesh::Point
Controllable:No
Description:The beginning of the line
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_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.
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.
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

(test/tests/mfem/complex/complex.i)

(test/tests/mfem/complex/complex.i)

mu = 1.0
epsilon = 1.0
sigma = 20.0
omega = 10.0
kappa_i = '${fparse -sqrt(mu*omega*sqrt(epsilon^2*omega^2+sigma^2)-epsilon*mu*omega^2)/sqrt(2)}'
kappa_r = '${fparse -mu*omega*sigma/kappa_i/2}'

[Mesh]
  type = MFEMFileMesh
  file = ../mesh/inline-quad.mesh
[]

[Problem]
  type = MFEMProblem
  numeric_type = complex
[]

[FESpaces]
  [H1FESpace]
    type = MFEMScalarFESpace
    fec_type = H1
    fec_order = FIRST
  []
[]

[Variables]
  [u]
    type = MFEMComplexVariable
    fespace = H1FESpace
  []
[]

[Functions]
  [u0_r]
    type = ParsedFunction
    expression = exp(y*${kappa_i})*cos(y*${kappa_r})
  []
  [u0_i]
    type = ParsedFunction
    expression = -exp(y*${kappa_i})*sin(y*${kappa_r})
  []
  [stiffnessCoef]
    type = ParsedFunction
    expression = 1.0/${mu}
  []
  [massCoef]
    type = ParsedFunction
    expression = -${omega}*${omega}*${epsilon}
  []
  [lossCoef]
    type = ParsedFunction
    expression = ${omega}*${sigma}
  []
[]

[BCs]
  [dbc]
    type = MFEMComplexScalarDirichletBC
    variable = u
    coefficient_real = u0_r
    coefficient_imag = u0_i
  []
[]

[Kernels]
  [diffusion_complex]
    type = MFEMComplexKernel
    variable = u
    [RealComponent]
      type = MFEMDiffusionKernel
      coefficient = stiffnessCoef
    []
    [ImagComponent]
      type = MFEMDiffusionKernel
      coefficient = 0.0
    []
  []
  [mass_complex]
    type = MFEMComplexKernel
    variable = u
    [RealComponent]
      type = MFEMMassKernel
      coefficient = massCoef
    []
    [ImagComponent]
      type = MFEMMassKernel
      coefficient = lossCoef
    []
  []
[]

[Solvers]
  [main]
    type = MFEMSuperLU
  []
[]

[Executioner]
  type = MFEMSteady
  assembly_level = legacy
[]

[VectorPostprocessors]
  [line_sample]
    type = MFEMComplexVariableLineValueSampler
    variable = 'u'
    start_point = '0 0 0'
    end_point = '1 1 0'
    num_points = 101
  []
[]

[Outputs]
  [CSV]
    type = CSV
    file_base = OutputData/complex_2d_quad
  []
[]

(test/tests/mfem/complex/complex.i)

mu = 1.0
epsilon = 1.0
sigma = 20.0
omega = 10.0
kappa_i = '${fparse -sqrt(mu*omega*sqrt(epsilon^2*omega^2+sigma^2)-epsilon*mu*omega^2)/sqrt(2)}'
kappa_r = '${fparse -mu*omega*sigma/kappa_i/2}'

[Mesh]
  type = MFEMFileMesh
  file = ../mesh/inline-quad.mesh
[]

[Problem]
  type = MFEMProblem
  numeric_type = complex
[]

[FESpaces]
  [H1FESpace]
    type = MFEMScalarFESpace
    fec_type = H1
    fec_order = FIRST
  []
[]

[Variables]
  [u]
    type = MFEMComplexVariable
    fespace = H1FESpace
  []
[]

[Functions]
  [u0_r]
    type = ParsedFunction
    expression = exp(y*${kappa_i})*cos(y*${kappa_r})
  []
  [u0_i]
    type = ParsedFunction
    expression = -exp(y*${kappa_i})*sin(y*${kappa_r})
  []
  [stiffnessCoef]
    type = ParsedFunction
    expression = 1.0/${mu}
  []
  [massCoef]
    type = ParsedFunction
    expression = -${omega}*${omega}*${epsilon}
  []
  [lossCoef]
    type = ParsedFunction
    expression = ${omega}*${sigma}
  []
[]

[BCs]
  [dbc]
    type = MFEMComplexScalarDirichletBC
    variable = u
    coefficient_real = u0_r
    coefficient_imag = u0_i
  []
[]

[Kernels]
  [diffusion_complex]
    type = MFEMComplexKernel
    variable = u
    [RealComponent]
      type = MFEMDiffusionKernel
      coefficient = stiffnessCoef
    []
    [ImagComponent]
      type = MFEMDiffusionKernel
      coefficient = 0.0
    []
  []
  [mass_complex]
    type = MFEMComplexKernel
    variable = u
    [RealComponent]
      type = MFEMMassKernel
      coefficient = massCoef
    []
    [ImagComponent]
      type = MFEMMassKernel
      coefficient = lossCoef
    []
  []
[]

[Solvers]
  [main]
    type = MFEMSuperLU
  []
[]

[Executioner]
  type = MFEMSteady
  assembly_level = legacy
[]

[VectorPostprocessors]
  [line_sample]
    type = MFEMComplexVariableLineValueSampler
    variable = 'u'
    start_point = '0 0 0'
    end_point = '1 1 0'
    num_points = 101
  []
[]

[Outputs]
  [CSV]
    type = CSV
    file_base = OutputData/complex_2d_quad
  []
[]

Overview
Example Input File Syntax
Input Parameters
Input Files