OPALX (Object Oriented Parallel Accelerator Library for Exascal) master (dc2a29eed580)
OPALX
Loading...
Searching...
No Matches
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.
 
virtual EVector Efield (const Point3D &P, double t) const
 Get field.
 
virtual BVector Bfield (const Point3D &P) const
 Get field.
 
virtual BVector Bfield (const Point3D &P, double t) const
 Get field.
 
virtual EBVectors EBfield (const Point3D &P) const
 Get field.
 
virtual EBVectors EBfield (const Point3D &P, double t) const
 Get field.
 
virtual void scale (double scalar)=0
 Scale the field.
 

Static Public Attributes

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

Detailed Description

Abstract base class for static magnetic fields.

Definition at line 29 of file StaticMagneticField.h.

Constructor & Destructor Documentation

◆ StaticMagneticField()

StaticMagneticField::StaticMagneticField ( )

Definition at line 26 of file StaticMagneticField.cpp.

◆ ~StaticMagneticField()

StaticMagneticField::~StaticMagneticField ( )
virtual

Definition at line 28 of file StaticMagneticField.cpp.

Member Function Documentation

◆ Bfield() [1/2]

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

◆ Bfield() [2/2]

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

Get field.

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

Definition at line 125 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 127 of file EMField.cpp.

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

Referenced by Component::EBfield(), 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 129 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 119 of file EMField.cpp.

References EMField::ZeroEfield.

Referenced by EMField::EBfield(), Component::Efield(), 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 123 of file EMField.cpp.

References EMField::Efield().

Here is the call graph for this function:

◆ scale()

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

Member Data Documentation

◆ ZeroBfield

const BVector EMField::ZeroBfield
staticinherited

The constant representing a zero magnetic field.

Definition at line 220 of file EMField.h.

Referenced by EMField::Bfield().

◆ ZeroEBfield

const EBVectors EMField::ZeroEBfield
staticinherited

The constant representing a zero electromagnetic field.

Definition at line 223 of file EMField.h.

◆ ZeroEfield

const EVector EMField::ZeroEfield
staticinherited

The constant representing a zero electric field.

Definition at line 217 of file EMField.h.

Referenced by EMField::Efield().


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