pspc/sweep/FieldState.h

#ifndef PSPC_FIELD_STATE_H
#define PSPC_FIELD_STATE_H
 
/*
* PSCF - Polymer Self-Consistent Field Theory
*
* Copyright 2016 - 2021, The Regents of the University of Minnesota
* Distributed under the terms of the GNU General Public License.
*/
 
#include <pscf/crystal/UnitCell.h>         // member
#include <pspc/field/FieldIo.h>            // member
#include <util/containers/DArray.h>        // member template
 
namespace Pscf {
namespace Pspc
{
 
   using namespace Util;
 
   template <int D> class System;
 
   template <int D, class FT>
   class FieldState 
   {
 
   public:
 
 
      FieldState();
 
      FieldState(System<D>& system);
 
      ~FieldState();
 
      void setSystem(System<D>& system);
 
 
      const DArray<FT>& fields() const;
 
      DArray<FT>& fields();
 
      const FT& field(int monomerId) const;
 
      FT& field(int monomerId);
 
      const UnitCell<D>& unitCell() const;
 
      UnitCell<D>& unitCell();
 
 
   protected:
 
      bool hasSystem();
 
      System<D>& system();
 
   private:
 
      DArray<FT> fields_;
 
      UnitCell<D> unitCell_;
 
      System<D>* systemPtr_;
 
   };
 
   // Public inline member functions
 
   // Get an array of all fields (const reference)
   template <int D, class FT>
   inline
   const DArray<FT>& FieldState<D,FT>::fields() const
   {  return fields_; }
 
   // Get an array of all fields (non-const reference)
   template <int D, class FT>
   inline
   DArray<FT>& FieldState<D,FT>::fields()
   {  return fields_; }
 
   // Get field for monomer type id (const reference)
   template <int D, class FT>
   inline
   const FT& FieldState<D,FT>::field(int id) const
   {  return fields_[id]; }
 
   // Get field for monomer type id (non-const reference)
   template <int D, class FT>
   inline FT& FieldState<D,FT>::field(int id)
   {  return fields_[id]; }
 
   // Get the internal Unitcell (const reference)
   template <int D, class FT>
   inline 
   const UnitCell<D>& FieldState<D,FT>::unitCell() const
   { return unitCell_; }
 
   // Get the internal Unitcell (non-const reference)
   template <int D, class FT>
   inline UnitCell<D>& FieldState<D,FT>::unitCell()
   { return unitCell_; }
 
   // Protected inline member functions
 
   // Has the system been set?
   template <int D, class FT>
   inline bool FieldState<D,FT>::hasSystem()
   {  return (systemPtr_ != 0); }
   
   // Get the associated System<D> object.
   template <int D, class FT>
   inline System<D>& FieldState<D,FT>::system()
   {
      assert(systemPtr_ != 0);  
      return *systemPtr_; 
   }
 
   #ifndef PSPC_FIELD_STATE_TPP
   // Suppress implicit instantiation
   extern template class FieldState< 1, DArray<double> >;
   extern template class FieldState< 2, DArray<double> >;
   extern template class FieldState< 3, DArray<double> >;
   #endif
 
} // namespace Pspc
} // namespace Pscf
#endif