Pscf::Rpg::Mask< D > Class Template Reference

A field to which the total monomer concentration is constrained. More...

#include <Mask.h>

Inheritance diagram for Pscf::Rpg::Mask< D >:

Additional Inherited Members
Public Member Functions inherited from Pscf::Rp::Mask< D, RField< D >, FieldIo< D > >
void	setFieldIo (FieldIo< D > const &fieldIo)
	Create association with FieldIo (store pointer).
void	setReadUnitCell (UnitCell< D > &cell)
	Set unit cell used when reading a mask field file.
void	setWriteUnitCell (UnitCell< D > const &cell)
	Set unit cell used when writing a mask field file.
void	allocateBasis (int nBasis)
	Allocate memory for the field in basis format.
void	allocateRGrid (IntVec< D > const &dimensions)
	Allocate memory for the field in rgrid format.
void	setBasis (DArray< double > const &field)
	Set field component values, in symmetrized Fourier format.
void	setRGrid (RField< D > const &field, bool isSymmetric=false)
	Set field values in real-space (r-grid) format.
void	readBasis (std::istream &in)
	Read field from input stream in symmetrized basis format.
void	readRGrid (std::istream &in, bool isSymmetric=false)
	Reads field from an input stream in real-space (r-grid) format.
void	writeBasis (std::ostream &out) const
	Write fields to an input stream in symmetrized basis format.
void	writeRGrid (std::ostream &out) const
	Writes fields to an input stream in real-space (r-grid) format.
DArray< double > const &	basis () const
	Get the field in basis format.
RField< D > const &	rgrid () const
	Get the field in r-grid format.
double	phiTot () const
	Return the volume fraction of unit cell occupied by material.
Signal< void > &	signal ()
	Get a signal that notifies observers of field modification.
bool	isAllocatedBasis () const
	Has memory been allocated in basis format?
bool	isAllocatedRGrid () const
	Has memory been allocated in rgrid format?
bool	hasData () const
	Has field data been set in either format?
bool	isSymmetric () const
	Are field symmetric under all elements of the space group?
Protected Member Functions inherited from Pscf::Rp::Mask< D, RField< D >, FieldIo< D > >
	Mask ()
	Constructor.
	~Mask ()
	Destructor.
IntVec< D > const &	meshDimensions () const
	Mesh dimensions in each direction, set by allocation.
int	meshSize () const
	Mesh size (number of grid points), set by allocation.
int	nBasis () const
	Number of basis functions, set by allocation.
FieldIo< D > const &	fieldIo () const
	Associated FieldIo object (const reference).

Detailed Description

template<int D>
class Pscf::Rpg::Mask< D >

A field to which the total monomer concentration is constrained.

Specializations of this template with D=1, 2, and 3 are derived from corresponding specializations of base class template Rp::Mask, and inherit their public interface and all of their source code from this base class.

See also

Rp::Mask

Definition at line 34 of file /field/Mask.h.

---

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

• /field/Mask.h