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. More...
	Grid (int numx=1, int numy=1, int numz=1, SCVector3 origin=SCVector3(0.0, 0.0, 0.0), SCVector3 axisx=SCVector3(1.0, 0.0, 0.0), SCVector3 axisy=SCVector3(0.0, 1.0, 0.0), SCVector3 axisz=SCVector3(0.0, 0.0, 1.0), Ref< Units > unit=new Units("bohr"))
Public Member Functions inherited from sc::DescribedClass
	DescribedClass (const DescribedClass &)
DescribedClass &	operator= (const DescribedClass &)
ClassDesc *	class_desc () const MPQC__NOEXCEPT
	This returns the unique pointer to the ClassDesc corresponding to the given type_info object. More...
const char *	class_name () const
	Return the name of the object's exact type.
int	class_version () const
	Return the version of the class.
virtual void	print (std::ostream &=ExEnv::out0()) const
	Print the object.
Ref< DescribedClass >	ref ()
	Return this object wrapped up in a Ref smart pointer. More...
Public Member Functions inherited from sc::RefCount
size_t	identifier () const
	Return the unique identifier for this object that can be compared for different objects of different types. More...
int	lock_ptr () const
	Lock this object.
int	unlock_ptr () const
	Unlock this object.
void	use_locks (bool inVal)
	start and stop using locks on this object
refcount_t	nreference () const
	Return the reference count.
refcount_t	reference ()
	Increment the reference count and return the new count.
refcount_t	dereference ()
	Decrement the reference count and return the new count.
int	managed () const
void	unmanage ()
	Turn off the reference counting mechanism for this object. More...

Public Attributes
int	numx
int	numy
int	numz
SCVector3	origin
SCVector3	axisx
SCVector3	axisy
SCVector3	axisz
Ref< Units >	unit

Additional Inherited Members
Protected Member Functions inherited from sc::RefCount
	RefCount (const RefCount &)
RefCount &	operator= (const RefCount &)

Detailed Description

The Grid class defines a finite regular Carthesian grid.

The grid can be 0, 1, 2 or 3 dimensional.

Constructor & Destructor Documentation

Grid()

sc::Grid::Grid

(

const Ref< KeyVal > &

)

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 default is [0 0 0].

axisx

Defines volume element length and direction for the first axis of the grid. The default is [1 0 0].

axisy

Same as axisx, but for the second axis. The default is [0 1 0].

axisz

Same as axisx, but for the third axis. The default is [0 0 1].

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