EM Namespace Reference

ElectromagneticConstants contains various constants useful in the Electromagnetic module, such as the complex number j, vacuum electric permittivity, etc. More...

Enumerations
enum	ComponentEnum { REAL , IMAGINARY }
	Enum used when determining the component of a field vector or complex coefficient. More...
enum	RobinEnum { ABSORBING , PORT }
	Enum used when determining the function of a Robin-style boundary condition. More...

Functions
static const std::complex< double >	j (0, 1)
	Complex number "j" (also known as "i")

Variables
static const Real	mu_0 = 4.0 * libMesh::pi * 1.0e-7
	Magnetic permeability of free space in SI units (H/m)
static const Real	c = 299792458
	Speed of light in vacuum in SI units (m/s)
static const Real	eps_0 = 1 / (mu_0 * c * c)
	Electric permittivity of free space in SI units (F/m)

Detailed Description

ElectromagneticConstants contains various constants useful in the Electromagnetic module, such as the complex number j, vacuum electric permittivity, etc.

ElectromagneticEnums contains various enumerations useful in the Electromagnetic module, such as real/imag component definitions in Kernels, BCs, etc.

Enumeration Type Documentation

ComponentEnum

enum EM::ComponentEnum

Enum used when determining the component of a field vector or complex coefficient.

Enumerator
REAL
IMAGINARY

Definition at line 20 of file ElectromagneticEnums.h.

{
  REAL,
  IMAGINARY
};

RobinEnum

enum EM::RobinEnum

Enum used when determining the function of a Robin-style boundary condition.

Enumerator
ABSORBING	Case when the boundary is configured to absorb impinging electromagnetic radiation.
PORT	Case when the boundary is configured to both absorb impinging electromagnetic radiation and launch an incoming pre-defined electromagnetic wave from the boundary into the simulation domain.

Definition at line 27 of file ElectromagneticEnums.h.

{
  ABSORBING, 
 
  PORT 
};

Function Documentation

j()

static const std::complex< double > EM::j ( 0  , 1    )

static

Complex number "j" (also known as "i")

Referenced by EMRobinBC::computeQpResidual(), VectorEMRobinBC::computeQpResidual(), VectorCurrentSource::computeQpResidual(), ReflectionCoefficient::computeReflection(), and JinSlabCoeffFunc::value().

Variable Documentation

c

const Real EM::c = 299792458

static

Speed of light in vacuum in SI units (m/s)

Definition at line 26 of file ElectromagneticConstants.h.

Referenced by VectorTransientAbsorbingBC::validParams().

eps_0

const Real EM::eps_0 = 1 / (mu_0 * c * c)

static

Electric permittivity of free space in SI units (F/m)

Definition at line 29 of file ElectromagneticConstants.h.

mu_0

const Real EM::mu_0 = 4.0 * libMesh::pi * 1.0e-7

static

Magnetic permeability of free space in SI units (H/m)

Definition at line 23 of file ElectromagneticConstants.h.

Referenced by VectorTransientAbsorbingBC::computeQpJacobian(), VectorTransientAbsorbingBC::computeQpOffDiagJacobian(), VectorTransientAbsorbingBC::computeQpResidual(), and VectorTransientAbsorbingBC::validParams().