OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
ConstBzField Class Reference

A homogeneous magnetostatic field in z-direction. More...

#include <ConstBzField.h>

Inheritance diagram for ConstBzField:
Collaboration diagram for ConstBzField:

Public Member Functions

 ConstBzField ()
 Default constructor.
virtual ~ConstBzField ()
virtual BVector Bfield (const Point3D &P) const
 Get field.
virtual BVector Bfield (const Point3D &P, double t) const
 Get field.
virtual double getBz () const
 Get component.
virtual void setBz (double Bz)
 Set component.
virtual void scale (double scalar)
 Scale the field.
virtual double getBx () const
 Get component.
virtual double getBy () const
 Get component.
virtual void setBx (double)
 Set component.
virtual void setBy (double)
 Set component.
virtual EVector Efield (const Point3D &P) const
 Get field.
virtual EVector Efield (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.

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.

Private Attributes

double Bz

Detailed Description

A homogeneous magnetostatic field in z-direction.

Definition at line 30 of file ConstBzField.h.

Constructor & Destructor Documentation

◆ ConstBzField()

ConstBzField::ConstBzField ( )

Default constructor.

Definition at line 27 of file ConstBzField.cpp.

◆ ~ConstBzField()

ConstBzField::~ConstBzField ( )
virtual

Definition at line 31 of file ConstBzField.cpp.

Member Function Documentation

◆ Bfield() [1/2]

BVector ConstBzField::Bfield ( const Point3D & P) const
virtual

Get field.

Reimplemented from EMField.

Definition at line 35 of file ConstBzField.cpp.

References Bz.

◆ Bfield() [2/2]

BVector ConstBzField::Bfield ( const Point3D & P,
double t ) const
virtual

Get field.

Reimplemented from EMField.

Definition at line 40 of file ConstBzField.cpp.

References Bz.

◆ 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
virtualinherited

Get component.

Reimplemented in BDipoleField.

Definition at line 35 of file ConstBField.cpp.

◆ getBy()

double ConstBField::getBy ( ) const
virtualinherited

Get component.

Reimplemented in BDipoleField.

Definition at line 39 of file ConstBField.cpp.

◆ getBz()

double ConstBzField::getBz ( ) const
virtual

Get component.

Reimplemented from ConstBField.

Definition at line 45 of file ConstBzField.cpp.

References Bz.

◆ scale()

void ConstBzField::scale ( double scalar)
virtual

Scale the field.

Implements EMField.

Definition at line 54 of file ConstBzField.cpp.

References Bz.

◆ setBx()

void ConstBField::setBx ( double )
virtualinherited

Set component.

Reimplemented in BDipoleField.

Definition at line 48 of file ConstBField.cpp.

◆ setBy()

void ConstBField::setBy ( double )
virtualinherited

Set component.

Reimplemented in BDipoleField.

Definition at line 52 of file ConstBField.cpp.

◆ setBz()

void ConstBzField::setBz ( double Bz)
virtual

Set component.

Reimplemented from ConstBField.

Definition at line 49 of file ConstBzField.cpp.

References Bz.

Member Data Documentation

◆ Bz

double ConstBzField::Bz
private

Definition at line 65 of file ConstBzField.h.

Referenced by Bfield(), Bfield(), getBz(), scale(), and setBz().

◆ 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: