OPALX (Object Oriented Parallel Accelerator Library for Exascal) master (dc2a29eed580)
OPALX
Loading...
Searching...
No Matches
ConstBField.h
Go to the documentation of this file.
1#ifndef OPALX_ConstBField_HH
2#define OPALX_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// Class ConstBField
26// ------------------------------------------------------------------------
28// A static magnetic field independent of (x,y,z).
29
31public:
33 // Constructs null field.
35
36 virtual ~ConstBField();
37
39 // Return the x-component of the magnetic field in T.
40 virtual double getBx() const;
41
43 // Return the y-component of the magnetic field in T.
44 virtual double getBy() const;
45
47 // Return the z-component of the magnetic field in T.
48 virtual double getBz() const;
49
51 // Assign the x-component of the magnetic field in T.
52 virtual void setBx(double);
53
55 // Assign the y-component of the magnetic field in T.
56 virtual void setBy(double);
57
59 // Assign the z-component of the magnetic field in T.
60 virtual void setBz(double);
61};
62
63#endif // OPALX_ConstBField_HH
A homogenous magnetostatic field.
Definition ConstBField.h:30
virtual void setBz(double)
Set component.
virtual void setBx(double)
Set component.
virtual double getBx() const
Get component.
virtual ~ConstBField()
virtual void setBy(double)
Set component.
virtual double getBy() const
Get component.
virtual double getBz() const
Get component.
ConstBField()
Default constructor.
Abstract base class for static magnetic fields.