OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
StaticElectricField Class Referenceabstract

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

#include <StaticElectricField.h>

Inheritance diagram for StaticElectricField:
Collaboration diagram for StaticElectricField:

Public Member Functions

 StaticElectricField ()
virtual ~StaticElectricField ()
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 electric fields.

Definition at line 30 of file StaticElectricField.h.

Constructor & Destructor Documentation

◆ StaticElectricField()

StaticElectricField::StaticElectricField ( )

Definition at line 27 of file StaticElectricField.cpp.

◆ ~StaticElectricField()

StaticElectricField::~StaticElectricField ( )
virtual

Definition at line 31 of file StaticElectricField.cpp.

Member Function Documentation

◆ Bfield() [1/2]

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

Get field.

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

Definition at line 168 of file EMField.cpp.

References ZeroBfield.

Referenced by Component::Bfield(), Component::Bfield(), Bfield(), and 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 Bfield(), and X.

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 Bfield(), Efield(), and X.

Referenced by Component::EBfield(), Component::EBfield(), and 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 EBfield(), and X.

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 ZeroEfield.

Referenced by EBfield(), Component::Efield(), Component::Efield(), and 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 Efield(), and X.

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 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 Efield().

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