API documentation
BiotSavartLoop Class Reference
Prototype of a Biot-Savart loop. More...
#include <BiotSavartLoop.h>
Inheritance diagram for BiotSavartLoop:
Collaboration diagram for BiotSavartLoop:
Public Member Functions | |
| BiotSavartLoop () | |
| Default constructor. | |
| ~BiotSavartLoop () | |
| Default destructor. | |
| virtual double | GetSensitivity (double *position) |
| Request sensitivity at given position. | |
| double | GetPhase (double *position) |
| Request sensitivity at given position. | |
| virtual BiotSavartLoop * | Clone () const |
| Clone. | |
| virtual bool | Prepare (PrepareMode mode) |
| Prepare. | |
Detailed Description
Prototype of a Biot-Savart loop.
Definition at line 32 of file BiotSavartLoop.h.
Member Function Documentation
| virtual BiotSavartLoop* BiotSavartLoop::Clone | ( | ) | const [inline, virtual] |
Clone.
- Returns:
- A clone.
Implements Coil.
Definition at line 68 of file BiotSavartLoop.h.
References BiotSavartLoop().
Here is the call graph for this function:
| double BiotSavartLoop::GetPhase | ( | double * | position | ) | [inline, virtual] |
Request sensitivity at given position.
- Parameters:
-
position Position.
- Returns:
- Sensitivity at requested position.
Reimplemented from Coil.
Definition at line 61 of file BiotSavartLoop.h.
| double BiotSavartLoop::GetSensitivity | ( | double * | position | ) | [virtual] |
Request sensitivity at given position.
- Parameters:
-
position Position.
- Returns:
- Sensitivity at requested position.
Implements Coil.
Definition at line 49 of file BiotSavartLoop.cpp.
References Coil::m_azimuth, Coil::m_extent, Coil::m_points, Coil::m_polar, and Coil::m_position.
| bool BiotSavartLoop::Prepare | ( | PrepareMode | mode | ) | [virtual] |
Prepare.
- Parameters:
-
mode Sets the preparation mode, one of enum PrepareMode {PREP_INIT,PREP_VERBOSE,PREP_UPDATE}.
- Returns:
- Success
Reimplemented from Coil.
Definition at line 33 of file BiotSavartLoop.cpp.
References Coil::DumpSensMap().
Here is the call graph for this function:
The documentation for this class was generated from the following files:
