TBTK
Public Member Functions | Friends | List of all members
TBTK::Property::Magnetization Class Reference

#include <Magnetization.h>

Public Member Functions

 Magnetization (int dimensions, const int *ranges)
 
 ~Magnetization ()
 
int getDimensions () const
 
const int * getRanges () const
 
int getSize () const
 
const std::complex< double > * getData () const
 

Friends

class TBTK::CPropertyExtractor
 
class TBTK::DPropertyExtractor
 
class TBTK::FileReader
 

Detailed Description

Container for magnetization.

Constructor & Destructor Documentation

TBTK::Property::Magnetization::Magnetization ( int  dimensions,
const int *  ranges 
)

Constructor.

TBTK::Property::Magnetization::~Magnetization ( )

Destructor.

Member Function Documentation

const std::complex< double > * TBTK::Property::Magnetization::getData ( ) const
inline

Get magnetization data.

int TBTK::Property::Magnetization::getDimensions ( ) const
inline

Get the dimension of the magnetization.

const int * TBTK::Property::Magnetization::getRanges ( ) const
inline

Get the ranges for the dimensions of the magnetization.

int TBTK::Property::Magnetization::getSize ( ) const
inline

Get the number of data elements.

Friends And Related Function Documentation

friend class TBTK::CPropertyExtractor
friend

CPropertyExtractor is a friend class to allow it to write magnetiation data.

friend class TBTK::DPropertyExtractor
friend

DPropertyExtractor is a friend class to allow it to write magnetiation data.

friend class TBTK::FileReader
friend

FileReader is a friend class to allow it to write magnetiation data.


The documentation for this class was generated from the following files: