sc::Grid Class Reference
The Grid class defines a finite regular Carthesian grid. More...
#include <math/mmisc/grid.h>
Inheritance diagram for sc::Grid:
Public Member Functions | |
| Grid (const Ref< KeyVal > &) | |
| The KeyVal constructor. | |
Public Attributes | |
| int | numx |
| int | numy |
| int | numz |
| SCVector3 | origin |
| SCVector3 | axisx |
| SCVector3 | axisy |
| SCVector3 | axisz |
| Ref< Units > | unit |
Detailed Description
The Grid class defines a finite regular Carthesian grid.The grid can be 0, 1, 2 or 3 dimensional.
Constructor & Destructor Documentation
The KeyVal constructor.
numx- The number of voxels along axisx (defined below). The default value is 1.
numy- The number of voxels along axisy (defined below). The default value is 1.
numz- The number of voxels along axisz (defined below). The default value is 1.
origin- The origin of the grid. The defuault is [0 0 0].
axisx- The direction of the first axis of the grid. The defuault is [0 0 0].
axisx- The direction of the second axis of the grid. The defuault is [0 0 0].
axisx- The direction of the thirds axis of the grid. The defuault is [0 0 0].
unit- The unit in which the parameters are given. Notice that this does not determine the unit used in the output file. The default value is bohr.
The documentation for this class was generated from the following file:
- src/lib/math/mmisc/grid.h