rpc/environment/FilmFieldGenExt.tpp

#ifndef RPC_EXT_GEN_FILM_TPP
#define RPC_EXT_GEN_FILM_TPP
 
/*
* 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.
*/
 
#include "FilmFieldGenExt.h"
#include <rpc/solvers/Mixture.h>
#include <rpc/field/Domain.h>
#include <rpc/field/FieldIo.h>
#include <rpc/field/CFields.h>
#include <rpc/field/WFields.h>
#include <rpc/field/Mask.h>
#include <rpc/scft/iterator/Iterator.h>
 
#include <prdc/cpu/RField.h>
#include <prdc/crystal/Basis.h>
#include <prdc/crystal/paramIdConversions.h>
#include <pscf/math/IntVec.h>
#include <cmath>
 
namespace Pscf {
namespace Rpc {
 
   using namespace Util;
   using namespace Pscf::Prdc;
   using namespace Pscf::Prdc::Cpu;
 
   /*
   * Default constructor
   */
   template <int D>
   FilmFieldGenExt<D>::FilmFieldGenExt()
    : FilmFieldGenExtBase<D>::FilmFieldGenExtBase(),
      sysPtr_(nullptr)
   {  setClassName("FilmFieldGenExt"); }
   
   /*
   * Constructor
   */
   template <int D>
   FilmFieldGenExt<D>::FilmFieldGenExt(System<D>& sys)
    : FilmFieldGenExtBase<D>::FilmFieldGenExtBase(),
      sysPtr_(&sys)
   {  setClassName("FilmFieldGenExt"); }
 
   /*
   * Destructor
   */
   template <int D>
   FilmFieldGenExt<D>::~FilmFieldGenExt()
   {}
 
   /*
   * Get contribution to the stress from these external fields
   */
   template <int D>
   double FilmFieldGenExt<D>::stress(int paramId) const
   {
      // If walls are athermal then there is no external field, so no
      // contribution to the stress.
      if (isAthermal()) return 0.0;
      
      // If paramId is not normalVecId, there is no stress contribution
      UTIL_CHECK(normalVecId() >= 0); // normalVecId has been set
      int nvParamId = convertFullParamIdToReduced<D>(normalVecId(),
                                                 system().domain().lattice());
      if (nvParamId != paramId) return 0.0;
 
      // If this point is reached, calculate the stress contribution
      // from the external fields.
      UTIL_CHECK(interfaceThickness() > 0); 
      UTIL_CHECK(system().mask().hasData());
      UTIL_CHECK(system().h().hasData());
 
      // Setup
      int nMonomer = system().mixture().nMonomer();
      int nx = system().domain().mesh().size();
      RField<D> const & maskRGrid = system().mask().rgrid();
      RField<D> maskDeriv, hDeriv;
      maskDeriv.allocate(system().domain().mesh().dimensions());
      hDeriv.allocate(system().domain().mesh().dimensions());
      IntVec<3> coords;
      int x, y, z;
      int counter = 0;
      double d, maskVal;
      double term = 0.0;
 
      // Create a 3 element vector 'dim' that contains the grid dimensions.
      // If system is 2D (1D), then the z (y & z) dimensions are set to 1.
      IntVec<3> dim;
      for (int ind = 0; ind < 3; ind++) {
         if (ind < D) {
            dim[ind] = system().domain().mesh().dimensions()[ind];
         } else {
            dim[ind] = 1;
         }
      }
 
      // Compute the derivative of the mask with respect to film thickness
      for (x = 0; x < dim[0]; x++) {
         coords[0] = x;
         for (y = 0; y < dim[1]; y++) {
            coords[1] = y;
            for (z = 0; z < dim[2]; z++) {
               coords[2] = z;
               maskVal = maskRGrid[counter];
 
               // Get the distance 'd' traveled along the lattice basis 
               // vector normal to the walls, in reduced coordinates
               d = (double)coords[normalVecId()] / 
                     (double)dim[normalVecId()];
 
               maskDeriv[counter] = maskVal * (maskVal - 1) * 8.0
                                    * (std::abs(d - 0.5) - 0.5)
                                    / interfaceThickness();
               counter++;
            }
         }
      }
 
      for (int i = 0; i < nMonomer; i++) {
         // Compute the h field derivative with respect to film thickness
         counter = 0;
         for (x = 0; x < dim[0]; x++) {
            coords[0] = x;
            for (y = 0; y < dim[1]; y++) {
               coords[1] = y;
               for (z = 0; z < dim[2]; z++) {
                  coords[2] = z;
                  if (coords[normalVecId()] < (dim[normalVecId()] / 2)) {
                     hDeriv[counter] = -1.0 * maskDeriv[counter] * chiBottom(i);
                  } else {
                     hDeriv[counter] = -1.0 * maskDeriv[counter] * chiTop(i);
                  }
                  counter++;
               }
            }
         }
 
         // Get the integral term in the stress
         RField<D> const & c = system().c().rgrid(i);
         for (int i = 0; i < nx; i++) {
            term += c[i] * hDeriv[i];
         }
      }
      term /= (system().mask().phiTot() * nx);
      return term;
   }

   template <int D>
   void FilmFieldGenExt<D>::compute()
   {
      // Set chiBottomCurrent_, chiTopCurrent_, and parametersCurrent_
      chiBottomCurrent_ = chiBottom();
      chiTopCurrent_ = chiTop();
      normalVecCurrent_ = systemLatticeVector(normalVecId());
      
      // If walls are athermal then there is no external field needed.
      // If external fields already exist in System, clear them, then return.
      if (isAthermal()) {
         system().h().clear();
         return;
      }
 
      // If this point is reached, external field must be computed
      UTIL_CHECK(normalVecId() >= 0);
      UTIL_CHECK(system().domain().unitCell().isInitialized());
      UTIL_CHECK(system().mask().hasData());
      if (system().iterator().isSymmetric()) {
         UTIL_CHECK(system().domain().basis().isInitialized());
      }
 
      int nm = systemNMonomer();
 
      // Create a 3 element vector 'dim' that contains the grid dimensions.
      // If system is 2D (1D), then the z (y & z) dimensions are set to 1.
      IntVec<3> dim;
      for (int ind = 0; ind < 3; ind++) {
         if (ind < D) {
            dim[ind] = system().domain().mesh().dimension(ind);
         } else {
            dim[ind] = 1;
         }
      }
 
      // Get pointer to mask RField
      RField<D> const & maskPtr = system().mask().rgrid();
 
      // Generate an r-grid representation of the external fields
      DArray< RField<D> > hRGrid;
      hRGrid.allocate(nm);
      for (int i = 0; i < nm; i++) {
         hRGrid[i].allocate(system().domain().mesh().dimensions());
      }
 
      int i, x, y, z;
      int counter = 0;
      IntVec<3> coords;
      double rhoW;
 
      for (i = 0; i < nm; i++) {
         for (x = 0; x < dim[0]; x++) {
            coords[0] = x;
            for (y = 0; y < dim[1]; y++) {
               coords[1] = y;
               for (z = 0; z < dim[2]; z++) {
                  coords[2] = z;
 
                  // Calculate wall volume fraction (rho_w) at gridpoint 
                  // (x,y,z)
                  rhoW = maskPtr[counter];
                  if (coords[normalVecId()] < (dim[normalVecId()]/2)) {
                     hRGrid[i][counter++] = (1.0-rhoW) * chiBottom(i);
                  } else {
                     hRGrid[i][counter++] = (1.0-rhoW) * chiTop(i);
                  }
               }
            }
         }
         counter = 0;
      } 
 
      // Pass h into the System
      system().h().setRGrid(hRGrid, system().iterator().isSymmetric());
   }
 
   /*
   * Get space group name for this system.
   */
   template <int D>
   std::string FilmFieldGenExt<D>::systemSpaceGroup() const
   {  return system().domain().groupName(); }
 
   /*
   * Get one of the lattice vectors for this system.
   */
   template <int D>
   RealVec<D> FilmFieldGenExt<D>::systemLatticeVector(int id) const
   {  return system().domain().unitCell().rBasis(id); }
 
   /*
   * Get the number of monomer species for this system.
   */
   template <int D>
   int FilmFieldGenExt<D>::systemNMonomer() const
   {  return system().mixture().nMonomer(); }
 
}
}
 
#endif