API documentation
World Class Reference
The simulated reality. More...
#include <World.h>
Collaboration diagram for World:
Public Member Functions | |
| virtual | ~World () |
| Default destructor. | |
| double | ConcomitantField (double *G) |
| Get concomitant field term for the current gradients. | |
| void | SetNoOfPools (int n) |
| Set number of sample pools. | |
| int | GetNoOfPools () |
| Set number of sample pools. | |
Static Public Member Functions | |
| static World * | instance () |
| Get sole instance of the sequence tree. | |
Public Attributes | |
| void(* | saveEvolFunPtr )(long, bool) |
| Pointer to the evolution saving function. | |
| void * | solverSettings |
| Arbitrary solver settings. | |
| bool | solverSuccess |
| true, if last calculation successful | |
| long | SpinNumber |
| Number of the current spin. | |
| long | TotalSpinNumber |
| Total number of spins. | |
| long | TotalADCNumber |
| Total number of spins. | |
| double * | Values |
| Values of the current spin (position and physical parameters). | |
| double | InitValues [NO_SPIN_PROPERTIES] |
| For initialization of Values. | |
| double | time |
| Current time point (in atom). | |
| double | total_time |
| Current time point (absolut time). | |
| double | phase |
| Receiver phase taken from the TPOIs. | |
| double | PhaseLock |
| Locked Phase (the phase set by the last RF pulse). | |
| double | deltaB |
| Any off-resonance terms. | |
| double | solution [3] |
| Solution [M_r, phi, M_z] at the current time point. | |
| double | RandNoise |
| percentage of random noise added to the signal | |
| double | GMAXoverB0 |
| Constant for the concomittant field term. | |
| double | NonLinGradField |
| Non-linear contriution to B_z from gradients. | |
| int | saveEvolStepSize |
| Step-size (in numbers of ADC) at which the evolution is stored. | |
| string | saveEvolFileName |
| Filename in which the evolution is stored. | |
| ofstream * | saveEvolOfstream |
| Output stream for saving the evolutions. | |
| AtomicSequence * | pAtom |
| Atomic sequence repsonsible for the current time point. | |
| AtomicSequence * | pStaticAtom |
| Atomic sequence repsonsible for all time points. | |
| int | m_myRank |
| MPI rank of this process. if m_myRank<0 process is serial jemris. | |
| bool | m_useLoadBalancing |
| use load balancing (send sample in small packages top slaves) | |
| int | m_no_processes |
| number of parallel processes; used by load balancing | |
| long | m_startSpin |
| start calculation with this spin ( in case of restart) | |
| int | m_noofpools |
| # of pools in sample | |
Detailed Description
The simulated reality.
Definition at line 42 of file World.h.
Member Function Documentation
| double World::ConcomitantField | ( | double * | G | ) |
| int World::GetNoOfPools | ( | ) | [inline] |
| void World::SetNoOfPools | ( | int | n | ) | [inline] |
Set number of sample pools.
- Parameters:
-
n Number of pools
Definition at line 69 of file World.h.
Referenced by Simulator::SetSample().
Here is the caller graph for this function:
The documentation for this class was generated from the following files:
