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

A homogenous magnetostatic field. More...

#include <ConstBField.h>

Inheritance diagram for ConstBField:
Collaboration diagram for ConstBField:

Public Member Functions

 ConstBField ()
 Default constructor.
virtual ~ConstBField ()
virtual double getBx () const
 Get component.
virtual double getBy () const
 Get component.
virtual double getBz () const
 Get component.
virtual void setBx (double)
 Set component.
virtual void setBy (double)
 Set component.
virtual void setBz (double)
 Set component.
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

A homogenous magnetostatic field.

Definition at line 31 of file ConstBField.h.

Constructor & Destructor Documentation

◆ ConstBField()

ConstBField::ConstBField ( )

Default constructor.

Definition at line 27 of file ConstBField.cpp.

◆ ~ConstBField()

ConstBField::~ConstBField ( )
virtual

Definition at line 31 of file ConstBField.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, 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:

◆ getBx()

double ConstBField::getBx ( ) const
virtual

Get component.

Reimplemented in BDipoleField.

Definition at line 35 of file ConstBField.cpp.

◆ getBy()

double ConstBField::getBy ( ) const
virtual

Get component.

Reimplemented in BDipoleField.

Definition at line 39 of file ConstBField.cpp.

◆ getBz()

double ConstBField::getBz ( ) const
virtual

Get component.

Reimplemented in ConstBzField.

Definition at line 43 of file ConstBField.cpp.

◆ scale()

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

◆ setBx()

void ConstBField::setBx ( double )
virtual

Set component.

Reimplemented in BDipoleField.

Definition at line 48 of file ConstBField.cpp.

◆ setBy()

void ConstBField::setBy ( double )
virtual

Set component.

Reimplemented in BDipoleField.

Definition at line 52 of file ConstBField.cpp.

◆ setBz()

void ConstBField::setBz ( double )
virtual

Set component.

Reimplemented in ConstBzField.

Definition at line 56 of file ConstBField.cpp.

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: