rpg/fts/analyzer/AverageAnalyzer.h

#ifndef RPG_AVERAGE_ANALYZER_H
#define RPG_AVERAGE_ANALYZER_H
 
/*
* PSCF - Polymer Self-Consistent Field Theory
*
* Copyright 2016 - 2022, The Regents of the University of Minnesota
* Distributed under the terms of the GNU General Public License.
*/
 
#include "Analyzer.h"
#include <util/accumulators/Average.h>           // member
 
namespace Pscf {
namespace Rpg {
 
   template <int D> class System;
   template <int D> class Simulator;
 
   using namespace Util;
 
   template <int D>
   class AverageAnalyzer : public Analyzer<D>
   {
 
   public:
 
      AverageAnalyzer(Simulator<D>& simulator, System<D>& system);
 
      virtual ~AverageAnalyzer();
 
      virtual void readParameters(std::istream& in);
 
      virtual void setup();
 
      virtual void sample(long iStep);
 
      virtual void output();
 
      int nSamplePerOutput() const;
 
      using ParamComposite::read;
      using ParamComposite::readOptional;
      using Analyzer<D>::interval;
      using Analyzer<D>::isAtInterval;
      using Analyzer<D>::outputFileName;
 
   protected:
 
      using Analyzer<D>::setClassName;
      using Analyzer<D>::readInterval;
      using Analyzer<D>::readOutputFileName;
 
      virtual double compute() = 0;
      
      virtual void outputValue(int step, double value);
 
      Simulator<D>& simulator();
 
      System<D>& system();
 
      // Output file stream
      std::ofstream outputFile_;
 
      Average accumulator_;
 
   private:
 
      Simulator<D>* simulatorPtr_;
 
      System<D>* systemPtr_;
 
      int nSamplePerOutput_;
 
   };
 
   // Inline functions
 
   // Get the parent Simulator.
   template <int D>
   inline Simulator<D>& AverageAnalyzer<D>::simulator()
   {  return *simulatorPtr_; }
 
   // Get the parent System.
   template <int D>
   inline System<D>& AverageAnalyzer<D>::system()
   {  return *systemPtr_; }
 
   // Get nSamplePerOutput.
   template <int D>
   inline int AverageAnalyzer<D>::nSamplePerOutput() const
   {  return nSamplePerOutput_; }
 
   #ifndef RPG_AVERAGE_ANALYZER_TPP
   // Suppress implicit instantiation
   extern template class AverageAnalyzer<1>;
   extern template class AverageAnalyzer<2>;
   extern template class AverageAnalyzer<3>;
   #endif
 
}
}
#endif