Spatial domain for a periodic structure with complex fields. More...

#include <Domain.h>

Inheritance diagram for Pscf::Cp::Domain< D, FFT, WLT, FIT >:

Public Member Functions
	Domain ()
	Constructor.
	~Domain ()
	Destructor.
Initialization
void	setFileMaster (FileMaster &fileMaster)
	Create association with a FileMaster, needed by FieldIo.
virtual void	readParameters (std::istream &in)
	Read body of parameter block (without opening and closing lines).
void	readFieldHeader (std::istream &in, int &nMonomer)
	Read initialization data from header of an r-grid field file.
Accessors (return component objects by reference)
Mesh< D > &	mesh ()
	Get the Mesh by non-const reference.
Mesh< D > const &	mesh () const
	Get the Mesh by const reference.
UnitCell< D > &	unitCell ()
	Get the UnitCell by non-const reference.
UnitCell< D > const &	unitCell () const
	Get the UnitCell by const reference.
FFT &	fft ()
	Get the FFT by non-const reference.
FFT const &	fft () const
	Get the FFT object by non-const reference.
WLT &	waveList ()
	Get the WaveList by non-const reference.
WLT const &	waveList () const
	Get the WaveList by const reference.
FIT &	fieldIo ()
	Get the FieldIo by non-const reference.
FIT const &	fieldIo () const
	Get the FieldIo by const reference.
UnitCell< D >::LatticeSystem	lattice () const
	Get the lattice system (enumeration value).
Public Member Functions inherited from Util::ParamComposite
	ParamComposite ()
	Constructor.
	ParamComposite (const ParamComposite &other)
	Copy constructor.
	ParamComposite (int capacity)
	Constructor.
virtual	~ParamComposite ()
	Virtual destructor.
void	resetParam ()
	Resets ParamComposite to its empty state.
virtual void	readParam (std::istream &in)
	Read the parameter file block.
virtual void	readParamOptional (std::istream &in)
	Read optional parameter file block.
virtual void	writeParam (std::ostream &out) const
	Write all parameters to an output stream.
virtual void	load (Serializable::IArchive &ar)
	Load all parameters from an input archive.
virtual void	loadOptional (Serializable::IArchive &ar)
	Load an optional ParamComposite.
virtual void	loadParameters (Serializable::IArchive &ar)
	Load state from archive, without adding Begin and End lines.
virtual void	save (Serializable::OArchive &ar)
	Saves all parameters to an archive.
void	saveOptional (Serializable::OArchive &ar)
	Saves isActive flag, and then calls save() iff isActive is true.
void	readParamComposite (std::istream &in, ParamComposite &child, bool next=true)
	Add and read a required child ParamComposite.
void	readParamCompositeOptional (std::istream &in, ParamComposite &child, bool next=true)
	Add and attempt to read an optional child ParamComposite.
template<typename Type>
ScalarParam< Type > &	read (std::istream &in, const char *label, Type &value)
	Add and read a new required ScalarParam < Type > object.
template<typename Type>
ScalarParam< Type > &	readOptional (std::istream &in, const char *label, Type &value)
	Add and read a new optional ScalarParam < Type > object.
template<typename Type>
CArrayParam< Type > &	readCArray (std::istream &in, const char label, Type value, int n)
	Add and read a required C array parameter.
template<typename Type>
CArrayParam< Type > &	readOptionalCArray (std::istream &in, const char label, Type value, int n)
	Add and read an optional C array parameter.
template<typename Type>
DArrayParam< Type > &	readDArray (std::istream &in, const char *label, DArray< Type > &array, int n)
	Add and read a required DArray < Type > parameter.
template<typename Type>
DArrayParam< Type > &	readOptionalDArray (std::istream &in, const char *label, DArray< Type > &array, int n)
	Add and read an optional DArray < Type > parameter.
template<typename Type, int N>
FArrayParam< Type, N > &	readFArray (std::istream &in, const char *label, FArray< Type, N > &array)
	Add and read a required FArray < Type, N > array parameter.
template<typename Type, int N>
FArrayParam< Type, N > &	readOptionalFArray (std::istream &in, const char *label, FArray< Type, N > &array)
	Add and read an optional FArray < Type, N > array parameter.
template<typename Type, int N>
FSArrayParam< Type, N > &	readFSArray (std::istream &in, const char *label, FSArray< Type, N > &array, int size)
	Add and read a required FSArray < Type, N > array parameter.
template<typename Type, int N>
FSArrayParam< Type, N > &	readOptionalFSArray (std::istream &in, const char *label, FSArray< Type, N > &array, int size)
	Add and read an optional FSArray < Type, N > array parameter.
template<typename Type>
CArray2DParam< Type > &	readCArray2D (std::istream &in, const char label, Type value, int m, int n, int np)
	Add and read a required CArray2DParam < Type > 2D C-array.
template<typename Type>
CArray2DParam< Type > &	readOptionalCArray2D (std::istream &in, const char label, Type value, int m, int n, int np)
	Add and read an optional CArray2DParam < Type > 2D C-array parameter.
template<typename Type>
DMatrixParam< Type > &	readDMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int m, int n)
	Add and read a required DMatrix < Type > matrix parameter.
template<typename Type>
DMatrixParam< Type > &	readOptionalDMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int m, int n)
	Add and read an optional DMatrix < Type > matrix parameter.
template<typename Type>
DSymmMatrixParam< Type > &	readDSymmMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int n)
	Add and read a required symmetrix DMatrix.
template<typename Type>
DSymmMatrixParam< Type > &	readOptionalDSymmMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int n)
	Add and read an optional DMatrix matrix parameter.
Begin &	readBegin (std::istream &in, const char *label, bool isRequired=true)
	Add and read a class label and opening bracket.
End &	readEnd (std::istream &in)
	Add and read the closing bracket.
Blank &	readBlank (std::istream &in)
	Add and read a new Blank object, representing a blank line.
void	loadParamComposite (Serializable::IArchive &ar, ParamComposite &child, bool next=true)
	Add and load a required child ParamComposite.
void	loadParamCompositeOptional (Serializable::IArchive &ar, ParamComposite &child, bool next=true)
	Add and load an optional child ParamComposite if isActive.
template<typename Type>
ScalarParam< Type > &	loadParameter (Serializable::IArchive &ar, const char *label, Type &value, bool isRequired)
	Add and load a new ScalarParam < Type > object.
template<typename Type>
ScalarParam< Type > &	loadParameter (Serializable::IArchive &ar, const char *label, Type &value)
	Add and load new required ScalarParam < Type > object.
template<typename Type>
CArrayParam< Type > &	loadCArray (Serializable::IArchive &ar, const char label, Type value, int n, bool isRequired)
	Add a C array parameter and load its elements.
template<typename Type>
CArrayParam< Type > &	loadCArray (Serializable::IArchive &ar, const char label, Type value, int n)
	Add and load a required CArrayParam< Type > array parameter.
template<typename Type>
DArrayParam< Type > &	loadDArray (Serializable::IArchive &ar, const char *label, DArray< Type > &array, int n, bool isRequired)
	Add an load a DArray < Type > array parameter.
template<typename Type>
DArrayParam< Type > &	loadDArray (Serializable::IArchive &ar, const char *label, DArray< Type > &array, int n)
	Add and load a required DArray< Type > array parameter.
template<typename Type, int N>
FArrayParam< Type, N > &	loadFArray (Serializable::IArchive &ar, const char *label, FArray< Type, N > &array, bool isRequired)
	Add and load an FArray < Type, N > fixed-size array parameter.
template<typename Type, int N>
FArrayParam< Type, N > &	loadFArray (Serializable::IArchive &ar, const char *label, FArray< Type, N > &array)
	Add and load a required FArray < Type > array parameter.
template<typename Type, int N>
FSArrayParam< Type, N > &	loadFSArray (Serializable::IArchive &ar, const char *label, FSArray< Type, N > &array, int size, bool isRequired)
	Add and load an FSArray < Type, N > array parameter.
template<typename Type, int N>
FSArrayParam< Type, N > &	loadFSArray (Serializable::IArchive &ar, const char *label, FSArray< Type, N > &array, int size)
	Add and load a required FSArray < Type > array parameter.
template<typename Type>
CArray2DParam< Type > &	loadCArray2D (Serializable::IArchive &ar, const char label, Type value, int m, int n, int np, bool isRequired)
	Add and load a CArray2DParam < Type > C 2D array parameter.
template<typename Type>
CArray2DParam< Type > &	loadCArray2D (Serializable::IArchive &ar, const char label, Type value, int m, int n, int np)
	Add and load a required < Type > matrix parameter.
template<typename Type>
DMatrixParam< Type > &	loadDMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int m, int n, bool isRequired)
	Add and load a DMatrixParam < Type > matrix parameter.
template<typename Type>
DMatrixParam< Type > &	loadDMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int m, int n)
	Add and load a required DMatrixParam < Type > matrix parameter.
template<typename Type>
DSymmMatrixParam< Type > &	loadDSymmMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int n, bool isRequired)
	Add and load a symmetric DSymmMatrixParam < Type > matrix parameter.
template<typename Type>
DSymmMatrixParam< Type > &	loadDSymmMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int n)
	Add and load a required DSymmMatrixParam < Type > matrix parameter.
void	addParamComposite (ParamComposite &child, bool next=true)
	Add a child ParamComposite object to the format array.
Begin &	addBegin (const char *label)
	Add a Begin object representing a class name and bracket.
End &	addEnd ()
	Add a closing bracket.
Blank &	addBlank ()
	Create and add a new Blank object, representing a blank line.
std::string	className () const
	Get class name string.
bool	isRequired () const
	Is this ParamComposite required in the input file?
bool	isActive () const
	Is this parameter active?
Public Member Functions inherited from Util::ParamComponent
virtual	~ParamComponent ()
	Destructor.
void	setIndent (const ParamComponent &parent, bool next=true)
	Set indent level.
std::string	indent () const
	Return indent string for this object (string of spaces).
template<class Archive>
void	serialize (Archive &ar, const unsigned int version)
	Serialize this ParamComponent as a string.
Public Member Functions inherited from Util::Serializable
virtual	~Serializable ()
	Destructor.
Public Member Functions inherited from Util::MpiFileIo
	MpiFileIo ()
	Constructor.
	MpiFileIo (const MpiFileIo &other)
	Copy constructor.
bool	isIoProcessor () const
	Can this processor do file I/O ?

Additional Inherited Members
Public Types inherited from Util::Serializable
typedef BinaryFileOArchive	OArchive
	Type of output archive used by save method.
typedef BinaryFileIArchive	IArchive
	Type of input archive used by load method.
Static Public Member Functions inherited from Util::ParamComponent
static void	initStatic ()
	Initialize static echo member to false.
static void	setEcho (bool echo=true)
	Enable or disable echoing for all subclasses of ParamComponent.
static bool	echo ()
	Get echo parameter.
void	setClassName (const char *className)
	Set class name string.
void	setIsRequired (bool isRequired)
	Set or unset the isActive flag.
void	setIsActive (bool isActive)
	Set or unset the isActive flag.
void	setParent (ParamComponent &param, bool next=true)
	Set this to the parent of a child component.
void	addComponent (ParamComponent &param, bool isLeaf=true)
	Add a new ParamComponent object to the format array.
template<typename Type>
ScalarParam< Type > &	add (std::istream &in, const char *label, Type &value, bool isRequired=true)
	Add a new required ScalarParam < Type > object.
template<typename Type>
CArrayParam< Type > &	addCArray (std::istream &in, const char label, Type value, int n, bool isRequired=true)
	Add (but do not read) a required C array parameter.
template<typename Type>
DArrayParam< Type > &	addDArray (std::istream &in, const char *label, DArray< Type > &array, int n, bool isRequired=true)
	Add (but do not read) a DArray < Type > parameter.
template<typename Type, int N>
FArrayParam< Type, N > &	addFArray (std::istream &in, const char *label, FArray< Type, N > &array, bool isRequired=true)
	Add (but do not read) a FArray < Type, N > array parameter.
template<typename Type, int N>
FSArrayParam< Type, N > &	addFSArray (std::istream &in, const char *label, FSArray< Type, N > &array, int size, bool isRequired=true)
	Add (but do not read) a FSArray < Type, N > array parameter.
template<typename Type>
CArray2DParam< Type > &	addCArray2D (std::istream &in, const char label, Type value, int m, int n, int np, bool isRequired=true)
	Add (but do not read) a CArray2DParam < Type > 2D C-array.
template<typename Type>
DMatrixParam< Type > &	addDMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int m, int n, bool isRequired=true)
	Add and read a required DMatrix < Type > matrix parameter.
Protected Member Functions inherited from Util::ParamComponent
	ParamComponent ()
	Constructor.
	ParamComponent (const ParamComponent &other)
	Copy constructor.

Detailed Description

template<int D, class FFT, class WLT, class FIT>
class Pscf::Cp::Domain< D, FFT, WLT, FIT >

Spatial domain for a periodic structure with complex fields.

A Domain template instance has:

a Mesh spatial discretization mesh
a UnitCell crystallographic unit cell
a FFT Fast Fourier Transform calculator (class FFT)
a WaveList container for wavevector properties (class WLT)
a FieldIo object for field IO & conversion operations (class FIT)
a lattice system enum (type Prdc::UnitCell<D>::LatticeSystem)

Note: Class names Pscf::Mesh, Prdc::UnitCell, etc. mentioned above refer to class templates with an integer template parameter D. Actual class names are Mesh <D>, Prdc::UnitCell <D>, etc. with D=1, 2, or 3.

Template Parameters :

D : integer dimension of space (D=1, 2, or 3)
FFT : Fast Fourier transform calculator type, e.g., FFT<D>
WLT : WaveList container type, e.g., WaveList<D>
FIT : FieldIo class for field operations, e.g., FieldIo<D>

Subclasses : Partial specializations of the Domain class template are used as base classes for classes Cpc::Domain <D> and Cpg::Domain <D>.

Definition at line 59 of file cp/field/Domain.h.

Constructor & Destructor Documentation

◆ Domain()

template<int D, class FFT, class WLT, class FIT>

Pscf::Cp::Domain< D, FFT, WLT, FIT >::Domain ( )

Constructor.

Definition at line 26 of file cp/field/Domain.tpp.

References fft(), fieldIo(), and Util::ParamComposite::setClassName().

◆ ~Domain()

template<int D, class FFT, class WLT, class FIT>

Pscf::Cp::Domain< D, FFT, WLT, FIT >::~Domain ( )

Destructor.

Definition at line 61 of file cp/field/Domain.tpp.

Member Function Documentation

◆ setFileMaster()

template<int D, class FFT, class WLT, class FIT>

void Pscf::Cp::Domain< D, FFT, WLT, FIT >::setFileMaster ( FileMaster & fileMaster )

Create association with a FileMaster, needed by FieldIo.

Parameters

fileMaster associated FileMaster object.

Definition at line 73 of file cp/field/Domain.tpp.

References fieldIo().

◆ readParameters()

template<int D, class FFT, class WLT, class FIT>

void Pscf::Cp::Domain< D, FFT, WLT, FIT >::readParameters ( std::istream & in )

virtual

Read body of parameter block (without opening and closing lines).

Parameters

in	input parameter stream

Reimplemented from Util::ParamComposite.

Reimplemented in Pscf::Cpc::Domain< D >.

Definition at line 83 of file cp/field/Domain.tpp.

References fft(), UTIL_CHECK, and waveList().

◆ readFieldHeader()

template<int D, class FFT, class WLT, class FIT>

void Pscf::Cp::Domain< D, FFT, WLT, FIT >::readFieldHeader	(	std::istream &	in,
		int &	nMonomer )

Read initialization data from header of an r-grid field file.

This is an alternative to reading the parameter file that is only used for unit testing.

Parameters

in	input parameter stream
nMonomer	number of monomers in field file (output)

Definition at line 117 of file cp/field/Domain.tpp.

References fft(), Pscf::Prdc::readFieldHeader(), UTIL_CHECK, UTIL_THROW, and waveList().

◆ mesh() [1/2]

template<int D, class FFT, class WLT, class FIT>

Mesh< D > & Pscf::Cp::Domain< D, FFT, WLT, FIT >::mesh ( )

inline

Get the Mesh by non-const reference.

Definition at line 245 of file cp/field/Domain.h.

◆ mesh() [2/2]

template<int D, class FFT, class WLT, class FIT>

Mesh< D > const & Pscf::Cp::Domain< D, FFT, WLT, FIT >::mesh ( ) const

inline

Get the Mesh by const reference.

Definition at line 250 of file cp/field/Domain.h.

◆ unitCell() [1/2]

template<int D, class FFT, class WLT, class FIT>

UnitCell< D > & Pscf::Cp::Domain< D, FFT, WLT, FIT >::unitCell ( )

inline

Get the UnitCell by non-const reference.

Definition at line 235 of file cp/field/Domain.h.

◆ unitCell() [2/2]

template<int D, class FFT, class WLT, class FIT>

UnitCell< D > const & Pscf::Cp::Domain< D, FFT, WLT, FIT >::unitCell ( ) const

inline

Get the UnitCell by const reference.

Definition at line 240 of file cp/field/Domain.h.

◆ fft() [1/2]

template<int D, class FFT, class WLT, class FIT>

FFT & Pscf::Cp::Domain< D, FFT, WLT, FIT >::fft ( )

inline

Get the FFT by non-const reference.

Definition at line 255 of file cp/field/Domain.h.

Referenced by Domain(), readFieldHeader(), and readParameters().

◆ fft() [2/2]

template<int D, class FFT, class WLT, class FIT>

FFT const & Pscf::Cp::Domain< D, FFT, WLT, FIT >::fft ( ) const

inline

Get the FFT object by non-const reference.

Definition at line 260 of file cp/field/Domain.h.

◆ waveList() [1/2]

template<int D, class FFT, class WLT, class FIT>

WLT & Pscf::Cp::Domain< D, FFT, WLT, FIT >::waveList ( )

inline

Get the WaveList by non-const reference.

Definition at line 265 of file cp/field/Domain.h.

Referenced by readFieldHeader(), and readParameters().

◆ waveList() [2/2]

template<int D, class FFT, class WLT, class FIT>

WLT const & Pscf::Cp::Domain< D, FFT, WLT, FIT >::waveList ( ) const

inline

Get the WaveList by const reference.

Definition at line 270 of file cp/field/Domain.h.

◆ fieldIo() [1/2]

template<int D, class FFT, class WLT, class FIT>

FIT & Pscf::Cp::Domain< D, FFT, WLT, FIT >::fieldIo ( )

inline

Get the FieldIo by non-const reference.

Definition at line 275 of file cp/field/Domain.h.

Referenced by Domain(), and setFileMaster().

◆ fieldIo() [2/2]

template<int D, class FFT, class WLT, class FIT>

FIT const & Pscf::Cp::Domain< D, FFT, WLT, FIT >::fieldIo ( ) const

inline

Get the FieldIo by const reference.

Definition at line 280 of file cp/field/Domain.h.

◆ lattice()

template<int D, class FFT, class WLT, class FIT>

UnitCell< D >::LatticeSystem Pscf::Cp::Domain< D, FFT, WLT, FIT >::lattice ( ) const

inline

Get the lattice system (enumeration value).

Definition at line 286 of file cp/field/Domain.h.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Domain()

◆ ~Domain()

Member Function Documentation

◆ setFileMaster()

◆ readParameters()

◆ readFieldHeader()

◆ mesh() [1/2]

◆ mesh() [2/2]

◆ unitCell() [1/2]

◆ unitCell() [2/2]

◆ fft() [1/2]

◆ fft() [2/2]

◆ waveList() [1/2]

◆ waveList() [2/2]

◆ fieldIo() [1/2]

◆ fieldIo() [2/2]

◆ lattice()