BaseCheckpointer.h

Go to the documentation of this file.

/*************************************************************************************
 
Grid physics library, www.github.com/paboyle/Grid
 
Source file: ./lib/qcd/hmc/BaseCheckpointer.h
 
Copyright (C) 2015
 
Author: Guido Cossu <guido.cossu@ed.ac.uk>
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
See the full license in the file "LICENSE" in the top level distribution
directory
*************************************************************************************/
               /*  END LEGAL */
#ifndef BASE_CHECKPOINTER
#define BASE_CHECKPOINTER
 
NAMESPACE_BEGIN(Grid);
 
class CheckpointerParameters : Serializable {
public:
  GRID_SERIALIZABLE_CLASS_MEMBERS(CheckpointerParameters, 
                  std::string, config_prefix, 
                  std::string, smeared_prefix, 
                  std::string, rng_prefix, 
                  int, saveInterval, 
                  bool, saveSmeared, 
                  std::string, format, 
                  std::string, group, 
                  bool, reduced_matrix, 
                  bool, unique_su, ); 
 
  CheckpointerParameters(std::string cf = "cfg", std::string sf="cfg_smr" , std::string rn = "rng", int savemodulo = 1, bool save_smr = false, const std::string& f = "IEEE64BIG", std::string grp = "su", bool rdc_mat = false, bool unq_su = false)
    : config_prefix(cf),
      smeared_prefix(sf),
      rng_prefix(rn),
      saveInterval(savemodulo),
      saveSmeared(save_smr),
      format(f),
      group(grp),
      reduced_matrix(rdc_mat),
      unique_su(unq_su) {};
 
 
  template <class ReaderClass >
  CheckpointerParameters(Reader<ReaderClass> &Reader) {
    read(Reader, "Checkpointer", *this);
  }
 
 
};

// Base class for checkpointers
template <class Impl>
class BaseHmcCheckpointer : public HmcObservable<typename Impl::Field> {
public:
  void build_filenames(int traj, CheckpointerParameters &Params,
                       std::string &conf_file,
                       std::string &smear_file,
               std::string &rng_file) {
    {
      std::ostringstream os;
      os << Params.rng_prefix << "." << traj;
      rng_file = os.str();
    }
 
    {
      std::ostringstream os;
      os << Params.smeared_prefix << "." << traj;
      smear_file = os.str();
    }
 
    {
      std::ostringstream os;
      os << Params.config_prefix << "." << traj;
      conf_file = os.str();
    }
  } 
  virtual ~BaseHmcCheckpointer(){};
  void check_filename(const std::string &filename){
    std::ifstream f(filename.c_str());
    if(!f.good()){
      std::cout << GridLogError << "Filename " << filename << " not found. Aborting. " << std::endl;
      abort();
    };
  }
  virtual void initialize(const CheckpointerParameters &Params) = 0;
 
  virtual void TrajectoryComplete(int traj,
                                  typename Impl::Field &U,
                                  GridSerialRNG &sRNG,
                                  GridParallelRNG &pRNG) { assert(0); } ; // HMC should pass the smart config with smeared and unsmeared
  
  virtual void CheckpointRestore(int traj, typename Impl::Field &U,
                                 GridSerialRNG &sRNG,
                                 GridParallelRNG &pRNG) = 0;
 
};  // class BaseHmcCheckpointer

 
NAMESPACE_END(Grid);
 
#endif