ScalarField.h File Reference

Real and complex scalar fields in real and reciprocal space. More...

#include <core/scalar.h>
#include <core/Util.h>
#include <core/ManagedMemory.h>
#include <core/matrix.h>
#include <core/GridInfo.h>
#include <memory>

Classes
struct	FieldData< T >
	ManagedMemory wrapper with gridInfo and pending scale factor for ScalarField* classes. More...
struct	FieldData< T >::PrivateTag
	Used to prevent direct use of ScalarField constructors, and force the shared_ptr usage. More...
struct	ScalarFieldData
	Real space real scalar field data Do not use this data structure directly or from a simple pointer ScalarFieldData*; work only with ScalarField's. The public functions of ScalarFieldData can be accessed with -> from the ScalarField. More...
struct	ScalarFieldTildeData
	Reciprocal space real scalar field data Do not use this data structure directly or from a simple pointer ScalarFieldTildeData*; work only with ScalarFieldTilde's. The public functions of ScalarFieldTildeData can be accessed with -> from the ScalarFieldTilde. More...
struct	complexScalarFieldData
	Real space complex scalar field data Do not use this data structure directly or from a simple pointer complexScalarFieldData*; work only with complexScalarField's. The public functions of complexScalarFieldData can be accessed with -> from the complexScalarField. More...
struct	complexScalarFieldTildeData
	Reciprocal space complex scalar field data Do not use this data structure directly or from a simple pointer complexScalarFieldTildeData*; work only with complexScalarFieldTilde's. The public functions of complexScalarFieldTildeData can be accessed with -> from the complexScalarFieldTilde. More...
struct	RealKernel
	Special class for storing real reciprocal-space kernels encountered ever so often for convolutions. More...

Macros
#define	getDataCode(dataLoc)

Typedefs
typedef std::shared_ptr< ScalarFieldData >	ScalarField
	A smart reference-counting pointer to ScalarFieldData.
typedef std::shared_ptr< ScalarFieldTildeData >	ScalarFieldTilde
	A smart reference-counting pointer to ScalarFieldTildeData.
typedef std::shared_ptr< complexScalarFieldData >	complexScalarField
	A smart reference-counting pointer to complexScalarFieldData.
typedef std::shared_ptr< complexScalarFieldTildeData >	complexScalarFieldTilde
	A smart reference-counting pointer to complexScalarFieldTildeData.

Detailed Description

Real and complex scalar fields in real and reciprocal space.

Macro Definition Documentation

getDataCode

#define getDataCode

(

dataLoc

)

Value:

                if(shouldAbsorbScale) absorbScale(); \
                return ManagedMemory<T>::dataLoc();