PSCF v1.4.0
Pscf::Rpc::CFields< D > Class Template Reference

A container for c fields stored in both basis and r-grid format. More...

#include <CFields.h>

Inheritance diagram for Pscf::Rpc::CFields< D >:
Pscf::Rp::CFields< D, RField< D >, FieldIo< D > >

Additional Inherited Members

Public Member Functions inherited from Pscf::Rp::CFields< D, RField< D >, FieldIo< D > >
void setFieldIo (FieldIo< D > const &fieldIo)
 Create association with FIT (store pointer).
void setWriteUnitCell (UnitCell< D > const &cell)
 Set unit cell used when writing field files.
void setNMonomer (int nMonomer)
 Set stored value of nMonomer.
void allocateRGrid (IntVec< D > const &dimensions)
 Allocate memory for fields in rgrid format.
void allocateBasis (int nBasis)
 Allocate or re-allocate memory for fields in basis format.
void allocate (int nMonomer, int nBasis, IntVec< D > const &dimensions)
 Allocate memory for both r-grid and basis field formats.
DArray< DArray< double > > & basis ()
 Get array of all fields in basis format (non-const).
DArray< RField< D > > & rgrid ()
 Get array of all fields in r-grid format (non-const).
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.
bool isAllocatedRGrid () const
 Has memory been allocated for fields in r-grid format?
bool isAllocatedBasis () const
 Has memory been allocated for fields in basis format?
bool hasData () const
 Does this container have up-to-date fields?
bool isSymmetric () const
 Are the fields invariant under elements of the space group?
void setHasData (bool hasData)
 Set the hasData flag.
void setIsSymmetric (bool isSymmetric)
 Set the isSymmetric flag.
Protected Member Functions inherited from Pscf::Rp::CFields< D, RField< D >, FieldIo< D > >
 CFields ()
 Constructor.
 ~CFields ()=default
 Destructor.
FieldIo< D > const & fieldIo () const
 Get associated FieldIo object (const reference).

Detailed Description

template<int D>
class Pscf::Rpc::CFields< D >

A container for c fields stored in both basis and r-grid format.

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

See also
Rp::CFields

Definition at line 36 of file rpc/field/CFields.h.


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