OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
Public Member Functions | Private Attributes | List of all members
ConstBzField Class Reference

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

#include <ConstBzField.h>

Inheritance diagram for ConstBzField:
Inheritance graph
[legend]
Collaboration diagram for ConstBzField:
Collaboration graph
[legend]

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.
 
- Public Member Functions inherited from ConstBField
 ConstBField ()
 Default constructor.
 
virtual ~ConstBField ()
 
virtual double getBx () const
 Get component.
 
virtual double getBy () const
 Get component.
 
virtual void setBx (double)
 Set component.
 
virtual void setBy (double)
 Set component.
 
- Public Member Functions inherited from StaticMagneticField
 StaticMagneticField ()
 
virtual ~StaticMagneticField ()
 
- Public Member Functions inherited from EMField
 EMField ()
 Default constructor.
 
 EMField (const EMField &right)
 
virtual ~EMField ()
 
const EMFieldoperator= (const EMField &right)
 
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.
 

Private Attributes

double Bz
 

Additional Inherited Members

- Static Public Attributes inherited from EMField
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 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.

◆ getBz()

double ConstBzField::getBz ( ) const
virtual

Get component.

Reimplemented from ConstBField.

Definition at line 45 of file ConstBzField.cpp.

References Bz.

Referenced by SolenoidRep::getBz().

◆ scale()

void ConstBzField::scale ( double  scalar)
virtual

Scale the field.

Implements EMField.

Definition at line 54 of file ConstBzField.cpp.

References Bz.

◆ setBz()

void ConstBzField::setBz ( double  Bz)
virtual

Set component.

Reimplemented from ConstBField.

Definition at line 49 of file ConstBzField.cpp.

References Bz.

Referenced by SolenoidRep::setBz().

Member Data Documentation

◆ Bz

double ConstBzField::Bz
private

Definition at line 65 of file ConstBzField.h.

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


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