OPAL (Object Oriented Parallel Accelerator Library) 2022.1
OPAL
ConstBField.h
Go to the documentation of this file.
1#ifndef CLASSIC_ConstBField_HH
2#define CLASSIC_ConstBField_HH
3
4// ------------------------------------------------------------------------
5// $RCSfile: ConstBField.h,v $
6// ------------------------------------------------------------------------
7// $Revision: 1.1.1.1 $
8// ------------------------------------------------------------------------
9// Copyright: see Copyright.readme
10// ------------------------------------------------------------------------
11//
12// Class: ConstBField
13//
14// ------------------------------------------------------------------------
15// Class category: Fields
16// ------------------------------------------------------------------------
17//
18// $Date: 2000/03/27 09:32:35 $
19// $Author: fci $
20//
21// ------------------------------------------------------------------------
22
24
25
26// Class ConstBField
27// ------------------------------------------------------------------------
29// A static magnetic field independent of (x,y,z).
30
32
33public:
34
36 // Constructs null field.
38
39 virtual ~ConstBField();
40
42 // Return the x-component of the magnetic field in T.
43 virtual double getBx() const;
44
46 // Return the y-component of the magnetic field in T.
47 virtual double getBy() const;
48
50 // Return the z-component of the magnetic field in T.
51 virtual double getBz() const;
52
54 // Assign the x-component of the magnetic field in T.
55 virtual void setBx(double);
56
58 // Assign the y-component of the magnetic field in T.
59 virtual void setBy(double);
60
62 // Assign the z-component of the magnetic field in T.
63 virtual void setBz(double);
64};
65
66#endif // CLASSIC_ConstBField_HH
A homogenous magnetostatic field.
Definition: ConstBField.h:31
virtual void setBz(double)
Set component.
Definition: ConstBField.cpp:56
virtual void setBx(double)
Set component.
Definition: ConstBField.cpp:48
virtual double getBx() const
Get component.
Definition: ConstBField.cpp:35
virtual ~ConstBField()
Definition: ConstBField.cpp:31
virtual void setBy(double)
Set component.
Definition: ConstBField.cpp:52
virtual double getBy() const
Get component.
Definition: ConstBField.cpp:39
virtual double getBz() const
Get component.
Definition: ConstBField.cpp:43
ConstBField()
Default constructor.
Definition: ConstBField.cpp:27
Abstract base class for static magnetic fields.