OPALX (Object Oriented Parallel Accelerator Library for Exascale) MINIorX
OPALX
Public Member Functions | Static Public Attributes | List of all members
StaticMagneticField Class Referenceabstract

Abstract base class for static magnetic fields. More...

#include <StaticMagneticField.h>

Inheritance diagram for StaticMagneticField:
Inheritance graph
Collaboration diagram for StaticMagneticField:
Collaboration graph

Public Member Functions

 StaticMagneticField ()
 
virtual ~StaticMagneticField ()
 
virtual EVector Efield (const Point3D &P) const
 Get field. More...
 
virtual EVector Efield (const Point3D &P, double t) const
 Get field. More...
 
virtual BVector Bfield (const Point3D &P) const
 Get field. More...
 
virtual BVector Bfield (const Point3D &P, double t) const
 Get field. More...
 
virtual EBVectors EBfield (const Point3D &P) const
 Get field. More...
 
virtual EBVectors EBfield (const Point3D &P, double t) const
 Get field. More...
 
virtual void scale (double scalar)=0
 Scale the field. More...
 

Static Public Attributes

static const EVector ZeroEfield
 The constant representing a zero electric field. More...
 
static const BVector ZeroBfield
 The constant representing a zero magnetic field. More...
 
static const EBVectors ZeroEBfield
 The constant representing a zero electromagnetic field. More...
 

Detailed Description

Abstract base class for static magnetic fields.

Definition at line 30 of file StaticMagneticField.h.

Constructor & Destructor Documentation

◆ StaticMagneticField()

StaticMagneticField::StaticMagneticField ( )

Definition at line 27 of file StaticMagneticField.cpp.

◆ ~StaticMagneticField()

StaticMagneticField::~StaticMagneticField ( )
virtual

Definition at line 31 of file StaticMagneticField.cpp.

Member Function Documentation

◆ Bfield() [1/2]

BVector EMField::Bfield ( const Point3D &  P) const
virtualinherited

Get field.

Reimplemented in BDipoleField, BMultipoleField, ConstBzField, OscillatingField< ConstEzField >, and BSingleMultipoleField< order >.

Definition at line 168 of file EMField.cpp.

References EMField::ZeroBfield.

Referenced by Component::Bfield(), EMField::Bfield(), and EMField::EBfield().

◆ Bfield() [2/2]

BVector EMField::Bfield ( const Point3D &  P,
double  t 
) const
virtualinherited

Get field.

Reimplemented in BDipoleField, BMultipoleField, BSingleMultipoleField< order >, ConstBzField, and OscillatingField< ConstEzField >.

Definition at line 178 of file EMField.cpp.

References EMField::Bfield().

Here is the call graph for this function:

◆ EBfield() [1/2]

EBVectors EMField::EBfield ( const Point3D &  P) const
virtualinherited

Get field.

Definition at line 183 of file EMField.cpp.

References EMField::Bfield(), and EMField::Efield().

Referenced by Component::EBfield(), and EMField::EBfield().

Here is the call graph for this function:

◆ EBfield() [2/2]

EBVectors EMField::EBfield ( const Point3D &  P,
double  t 
) const
virtualinherited

Get field.

Definition at line 188 of file EMField.cpp.

References EMField::EBfield().

Here is the call graph for this function:

◆ Efield() [1/2]

EVector EMField::Efield ( const Point3D &  P) const
virtualinherited

Get field.

Reimplemented in ConstEzField, and OscillatingField< ConstEzField >.

Definition at line 163 of file EMField.cpp.

References EMField::ZeroEfield.

Referenced by EMField::EBfield(), Component::Efield(), and EMField::Efield().

◆ Efield() [2/2]

EVector EMField::Efield ( const Point3D &  P,
double  t 
) const
virtualinherited

Get field.

Reimplemented in ConstEzField, and OscillatingField< ConstEzField >.

Definition at line 173 of file EMField.cpp.

References EMField::Efield().

Here is the call graph for this function:

◆ scale()

virtual void EMField::scale ( double  scalar)
pure virtualinherited

Scale the field.

Implemented in BDipoleField, BMultipoleField, BSingleMultipoleField< order >, ConstBzField, ConstEzField, and NullField.

Member Data Documentation

◆ ZeroBfield

const BVector EMField::ZeroBfield
staticinherited

The constant representing a zero magnetic field.

Definition at line 239 of file EMField.h.

Referenced by EMField::Bfield().

◆ ZeroEBfield

const EBVectors EMField::ZeroEBfield
staticinherited

The constant representing a zero electromagnetic field.

Definition at line 242 of file EMField.h.

◆ ZeroEfield

const EVector EMField::ZeroEfield
staticinherited

The constant representing a zero electric field.

Definition at line 236 of file EMField.h.

Referenced by EMField::Efield().

The documentation for this class was generated from the following files: