FieldState for fields in symmetry-adapted basis format. More...
#include <BasisFieldState.h>
Public Member Functions | |
| BasisFieldState () | |
| Default constructor. More... | |
| BasisFieldState (System< D > &system) | |
| Constructor, create association with a parent system. More... | |
| ~BasisFieldState () | |
| Destructor. More... | |
| void | allocate () |
| Allocate all fields. More... | |
| void | read (const std::string &filename) |
| Read state from file. More... | |
| void | write (const std::string &filename) |
| Write state to file. More... | |
| void | getSystemState () |
| Copy the current state of the associated system. More... | |
| void | setSystemState (bool newCellParams) |
| Set the state of the associated system to this state. More... | |
 Public Member Functions inherited from Pscf::Pspg::FieldState< D, FT > | |
| FieldState () | |
| Default constructor. More... | |
| FieldState (System< D > &system) | |
| Constructor, creates association with a System. More... | |
| ~FieldState () | |
| Destructor. More... | |
| void | setSystem (System< D > &system) |
| Set association with System, after default construction. More... | |
| const DArray< FT > & | fields () const |
| Get array of all fields by const reference. More... | |
| DArray< FT > & | fields () |
| Get array of all chemical potential fields (non-const reference). More... | |
| const FT & | field (int monomerId) const |
| Get a field for a single monomer type by const reference. More... | |
| FT & | field (int monomerId) |
| Get field for a specific monomer type (non-const reference). More... | |
| const UnitCell< D > & | unitCell () const |
| Get UnitCell (i.e., lattice type and parameters) by const reference. More... | |
| UnitCell< D > & | unitCell () |
| Get the UnitCell by non-const reference. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from Pscf::Pspg::FieldState< D, FT > | |
| bool | hasSystem () |
| Has a system been set? More... | |
| System< D > & | system () |
| Get associated System by reference. More... | |
Detailed Description
class Pscf::Pspg::BasisFieldState< D >
FieldState for fields in symmetry-adapted basis format.
Definition at line 24 of file pspg/sweep/BasisFieldState.h.
Constructor & Destructor Documentation
◆ BasisFieldState() [1/2]
| Pscf::Pspg::BasisFieldState< D >::BasisFieldState |
Default constructor.
Definition at line 27 of file pspg/sweep/BasisFieldState.tpp.
◆ BasisFieldState() [2/2]
| Pscf::Pspg::BasisFieldState< D >::BasisFieldState | ( | System< D > & | system | ) |
Constructor, create association with a parent system.
- Parameters
-
system associated parent system
Definition at line 35 of file pspg/sweep/BasisFieldState.tpp.
◆ ~BasisFieldState()
| Pscf::Pspg::BasisFieldState< D >::~BasisFieldState |
Destructor.
Definition at line 43 of file pspg/sweep/BasisFieldState.tpp.
Member Function Documentation
◆ allocate()
| void Pscf::Pspg::BasisFieldState< D >::allocate |
Allocate all fields.
Precondition: hasSystem() == true
Definition at line 50 of file pspg/sweep/BasisFieldState.tpp.
References UTIL_CHECK.
Referenced by Pscf::Pspg::Sweep< D >::checkAllocation().
◆ read()
| void Pscf::Pspg::BasisFieldState< D >::read | ( | const std::string & | filename | ) |
Read state from file.
Read fields in symmetry-adapted basis format.
- Parameters
-
filename name of input w-field file in symmetry-adapted format.
Definition at line 79 of file pspg/sweep/BasisFieldState.tpp.
Referenced by pscfpp.param.Composite::__init__(), pscfpp.field.Field::__init__(), pscfpp.command.Script::__init__(), pscfpp.output.Thermo::__init__(), pscfpp.param.Matrix::__init__(), and pscfpp.param.Array::__init__().
◆ write()
| void Pscf::Pspg::BasisFieldState< D >::write | ( | const std::string & | filename | ) |
Write state to file.
Write fields in symmetry-adapted basis format.
- Parameters
-
filename name of output file, in symmetry-adapated format.
Definition at line 89 of file pspg/sweep/BasisFieldState.tpp.
◆ getSystemState()
| void Pscf::Pspg::BasisFieldState< D >::getSystemState |
Copy the current state of the associated system.
Copy the fields and the unit cell.
Definition at line 98 of file pspg/sweep/BasisFieldState.tpp.
◆ setSystemState()
| void Pscf::Pspg::BasisFieldState< D >::setSystemState | ( | bool | newCellParams | ) |
Set the state of the associated system to this state.
- Parameters
-
newCellParams update system unit cell iff newCellParams == true.
Definition at line 121 of file pspg/sweep/BasisFieldState.tpp.
The documentation for this class was generated from the following files:
