rpc/environment/FilmEnvironment.h

#ifndef RPC_FILM_ENVIRONMENT_H
#define RPC_FILM_ENVIRONMENT_H
 
/*
* PSCF - Polymer Self-Consistent Field
*
* Copyright 2015 - 2025, The Regents of the University of Minnesota
* Distributed under the terms of the GNU General Public License.
*/
 
/*
* NOTE: In this file, we break from PSCF's conventional coding standards.
* Specifically, any subclass of MixAndMatchEnv in the Rpc namespace should 
* be declared in this header file, and the methods should be defined in 
* the class declaration rather than in a .tpp file. This is simply for the 
* sake of conciseness. These subclasses of MixAndMatchEnv require very
* little code to declare and define, so we opt to consolidate the code 
* into a single file rather than spreading it across many small files.
*/
 
#include "FilmFieldGenMask.h"
#include "FilmFieldGenExt.h"
#include <prdc/environment/MixAndMatchEnv.h>
 
namespace Pscf {
namespace Rpc {
 
   using namespace Util;
 
   template <int D> 
   class System;

   template <int D>
   class FilmEnvironment : public MixAndMatchEnv
   {
 
   public:

      FilmEnvironment(System<D>& sys)
       : MixAndMatchEnv::MixAndMatchEnv(),
         sysPtr_(&sys)
      {  ParamComposite::setClassName("FilmEnvironment"); }

      ~FilmEnvironment()
      {}
 
   private:

      System<D>* sysPtr_;

      void createGenerators()
      {
         MixAndMatchEnv::fieldGenPtr1_ = new FilmFieldGenMask<D>(*sysPtr_);
         MixAndMatchEnv::fieldGenPtr2_ = new FilmFieldGenExt<D>(*sysPtr_);
      }
 
   };
 
   // Suppress implicit instantiation
   extern template class FilmEnvironment<1>;
   extern template class FilmEnvironment<2>;
   extern template class FilmEnvironment<3>;
 
} // namespace Rpc
} // namespace Pscf
#endif