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

#include <ConstEzField.h>

Inheritance diagram for ConstEzField:
Collaboration diagram for ConstEzField:

Public Member Functions

 ConstEzField ()
 Default constructor.
virtual ~ConstEzField ()
virtual EVector Efield (const Point3D &P) const
 Get field.
virtual EVector Efield (const Point3D &P, double t) const
 Get field.
virtual double getEz () const
 Get component.
virtual void setEz (double)
 Set component.
virtual void scale (double scalar)
 Scale the 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.

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 Ez

Detailed Description

Definition at line 23 of file ConstEzField.h.

Constructor & Destructor Documentation

◆ ConstEzField()

ConstEzField::ConstEzField ( )

Default constructor.

Definition at line 21 of file ConstEzField.cpp.

◆ ~ConstEzField()

ConstEzField::~ConstEzField ( )
virtual

Definition at line 25 of file ConstEzField.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 ConstEzField::Efield ( const Point3D & P) const
virtual

Get field.

Reimplemented from EMField.

Reimplemented in OscillatingField< ConstEzField >.

Definition at line 29 of file ConstEzField.cpp.

References Ez.

◆ Efield() [2/2]

EVector ConstEzField::Efield ( const Point3D & P,
double t ) const
virtual

Get field.

Reimplemented from EMField.

Reimplemented in OscillatingField< ConstEzField >.

Definition at line 34 of file ConstEzField.cpp.

References Ez.

◆ getEz()

double ConstEzField::getEz ( ) const
virtual

Get component.

Definition at line 39 of file ConstEzField.cpp.

References Ez.

◆ scale()

void ConstEzField::scale ( double scalar)
virtual

Scale the field.

Implements EMField.

Definition at line 49 of file ConstEzField.cpp.

References Ez.

◆ setEz()

void ConstEzField::setEz ( double value)
virtual

Set component.

Definition at line 44 of file ConstEzField.cpp.

References Ez.

Member Data Documentation

◆ Ez

double ConstEzField::Ez
private

Definition at line 56 of file ConstEzField.h.

Referenced by Efield(), Efield(), getEz(), scale(), and setEz().

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