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

FieldState for fields in symmetry-adapted basis format. More...

#include <BasisFieldState.h>

Inheritance diagram for Pscf::Rpc::BasisFieldState< D >:
Pscf::Rp::BasisFieldState< D, Types< D > > Pscf::Prdc::FieldState< D, FT, ST >

Public Member Functions

 BasisFieldState ()
 Default constructor.
 BasisFieldState (System< D > &system)
 Constructor, create association with a parent system.
Public Member Functions inherited from Pscf::Rp::BasisFieldState< D, Types< D > >
void allocate ()
 Allocate all fields.
void read (const std::string &filename)
 Read state from file.
void write (const std::string &filename)
 Write state to file.
void getSystemState ()
 Store the current state of the associated system.
void setSystemState (bool newCellParams)
 Set the state of the associated system to this state.
Public Member Functions inherited from Pscf::Prdc::FieldState< D, FT, ST >
 FieldState ()
 Default constructor.
 FieldState (ST &system)
 Constructor, creates association with a System.
 ~FieldState ()
 Destructor.
void setSystem (ST &system)
 Set association with System, after default construction.
const DArray< FT > & fields () const
 Get array of all fields by const reference.
DArray< FT > & fields ()
 Get array of all chemical potential fields (non-const reference).
const FT & field (int monomerId) const
 Get a field for a single monomer type by const reference.
FT & field (int monomerId)
 Get field for a specific monomer type (non-const reference).
const UnitCell< D > & unitCell () const
 Get UnitCell (i.e., lattice type and parameters) by const reference.
UnitCell< D > & unitCell ()
 Get the UnitCell by non-const reference.

Additional Inherited Members

Protected Member Functions inherited from Pscf::Rp::BasisFieldState< D, Types< D > >
 BasisFieldState ()
 Default constructor.
Protected Member Functions inherited from Pscf::Prdc::FieldState< D, FT, ST >
bool hasSystem ()
 Has a system been set?
ST & system ()
 Get associated System by reference.

Detailed Description

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

FieldState for fields in symmetry-adapted basis format.

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

See also
Rp::BasisFieldState

Definition at line 32 of file /scft/sweep/BasisFieldState.h.

Constructor & Destructor Documentation

◆ BasisFieldState() [1/2]

template<int D>
Pscf::Rpc::BasisFieldState< D >::BasisFieldState ( )

Default constructor.

Definition at line 26 of file BasisFieldState.cpp.

References BasisFieldState().

Referenced by BasisFieldState(), and BasisFieldState().

◆ BasisFieldState() [2/2]

template<int D>
Pscf::Rpc::BasisFieldState< D >::BasisFieldState ( System< D > & system)

Constructor, create association with a parent system.

Parameters
systemassociated parent system

Definition at line 32 of file BasisFieldState.cpp.

References BasisFieldState(), and Pscf::Rp::BasisFieldState< D, Types< D > >::system().


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