test_HMC_Clover_RHMC_Nf2p1.cpp

Go to the documentation of this file.

#include "test.h"

#include "Action/Fermion/action_F_Standard_lex.h"
#include "Action/Fermion/action_F_Ratio_lex.h"
#include "Action/Fermion/action_F_Rational.h"

#include "Fopr/fopr_Smeared.h"

#include "Force/Fermion/force_F_Clover_Nf2.h"
#include "Force/Fermion/force_F_Smeared.h"

#include "HMC/hmc_General.h"
#include "HMC/builder_Integrator.h"

#include "IO/gaugeConfig.h"

#include "Measurements/Fermion/fprop_Standard_lex.h"

#include "Tools/file_utils.h"
#include "Tools/randomNumberManager.h"
#include "Tools/randomNumbers_Mseries.h"

//====================================================================

namespace Test_HMC_Clover {
  const std::string test_name = "HMC.Clover.RHMC_Nf2p1";

  //- test-private parameters
  namespace {
    const std::string filename_input = "test_HMC_Clover_RHMC_Nf2p1.yaml";
  }

  //- prototype declaration
  int RHMC_Nf2p1(void);

#ifdef USE_TESTMANAGER_AUTOREGISTER
  namespace {
#if defined(USE_GROUP_SU2)
    // Nc=2 is not available.
#else
    static const bool is_registered = TestManager::RegisterTest(
      test_name,
      RHMC_Nf2p1
      );
#endif
  }
#endif

  //====================================================================
  int RHMC_Nf2p1(void)
  {
    // #####  parameter setup  #####
    const int Nc   = CommonParameters::Nc();
    const int Nvol = CommonParameters::Nvol();
    const int Ndim = CommonParameters::Ndim();

    const Parameters params_all = ParameterManager::read(filename_input);

    const Parameters params_test               = params_all.lookup("Test_HMC_Clover");
    const Parameters params_action_G           = params_all.lookup("Action_G");
    const Parameters params_fopr_Nf2           = params_all.lookup("Fopr_Nf2");
    const Parameters params_fopr_Nf2_prec      = params_all.lookup("Fopr_Nf2_prec");
    const Parameters params_fopr_Nf1           = params_all.lookup("Fopr_Nf1");
    const Parameters params_proj               = params_all.lookup("Projection");
    const Parameters params_smear              = params_all.lookup("Smear");
    const Parameters params_dr_smear           = params_all.lookup("Director_Smear");
    const Parameters params_rational_MD        = params_all.lookup("Fopr_Rational_MD");
    const Parameters params_rational_H         = params_all.lookup("Fopr_Rational_H");
    const Parameters params_solver_Nf2_MD      = params_all.lookup("Solver_Nf2_MD");
    const Parameters params_solver_Nf2_H       = params_all.lookup("Solver_Nf2_H");
    const Parameters params_solver_Nf2_MD_prec = params_all.lookup("Solver_Nf2_MD_prec");
    const Parameters params_solver_Nf2_H_prec  = params_all.lookup("Solver_Nf2_H_prec");
    const Parameters params_integrator         = params_all.lookup("Builder_Integrator");
    const Parameters params_hmc = params_all.lookup("HMC_General");

    const string        str_gconf_status = params_test.get_string("gauge_config_status");
    const string        str_gconf_read   = params_test.get_string("gauge_config_type_input");
    const string        readfile         = params_test.get_string("config_filename_input");
    const string        str_gconf_write  = params_test.get_string("gauge_config_type_output");
    const string        writefile        = params_test.get_string("config_filename_output");
    const string        str_rand_type    = params_test.get_string("random_number_type");
    const unsigned long seed             = params_test.get_unsigned_long("seed_for_random_number");
    int                 i_conf           = params_test.get_int("trajectory_number");
    const int           Ntraj            = params_test.get_int("trajectory_number_step");
    const int           i_save_conf      = params_test.get_int("save_config_interval");
    const string        str_vlevel       = params_test.get_string("verbose_level");

    const bool   do_check        = params_test.is_set("expected_result");
    const double expected_result = do_check ? params_test.get_double("expected_result") : 0.0;

    const string           str_action_G_type           = params_action_G.get_string("action_type");
    const string           str_fopr_Nf2_type           = params_fopr_Nf2.get_string("fermion_type");
    const string           str_fopr_Nf2_prec_type      = params_fopr_Nf2_prec.get_string("fermion_type");
    const string           str_fopr_Nf1_type           = params_fopr_Nf1.get_string("fermion_type");
    const string           str_gmset_type              = params_fopr_Nf2.get_string("gamma_matrix_type");
    const string           str_proj_type               = params_proj.get_string("projection_type");
    const string           str_smear_type              = params_smear.get_string("smear_type");
    // const int Nsmear                                 = params_dr_smear.get_int("number_of_smearing");
    const string           str_solver_Nf2_MD_type      = params_solver_Nf2_MD.get_string("solver_type");
    const string           str_solver_Nf2_H_type       = params_solver_Nf2_H.get_string("solver_type");
    const string           str_solver_Nf2_MD_prec_type = params_solver_Nf2_MD_prec.get_string("solver_type");
    const string           str_solver_Nf2_H_prec_type  = params_solver_Nf2_H_prec.get_string("solver_type");
    const int              Nlevels      = params_integrator.get_int("number_of_levels");
    const std::vector<int> level_action = params_integrator.get_int_vector("level_of_actions");

    const Bridge::VerboseLevel vl = vout.set_verbose_level(str_vlevel);

    //- print input parameters
    vout.general(vl, "  gconf_status            = %s\n", str_gconf_status.c_str());
    vout.general(vl, "  gconf_read              = %s\n", str_gconf_read.c_str());
    vout.general(vl, "  readfile                = %s\n", readfile.c_str());
    vout.general(vl, "  gconf_write             = %s\n", str_gconf_write.c_str());
    vout.general(vl, "  writefile               = %s\n", writefile.c_str());
    vout.general(vl, "  rand_type               = %s\n", str_rand_type.c_str());
    vout.general(vl, "  seed                    = %lu\n", seed);
    vout.general(vl, "  i_conf                  = %d\n", i_conf);
    vout.general(vl, "  Ntraj                   = %d\n", Ntraj);
    vout.general(vl, "  i_save_conf             = %d\n", i_save_conf);
    vout.general(vl, "  vlevel                  = %s\n", str_vlevel.c_str());
    vout.general(vl, "  gmset_type              = %s\n", str_gmset_type.c_str());
    vout.general(vl, "  proj_type               = %s\n", str_proj_type.c_str());
    vout.general(vl, "  smear_type              = %s\n", str_smear_type.c_str());
    vout.general(vl, "  solver_Nf2_MD_type      = %s\n", str_solver_Nf2_MD_type.c_str());
    vout.general(vl, "  solver_Nf2_H_type       = %s\n", str_solver_Nf2_H_type.c_str());
    vout.general(vl, "  solver_Nf2_MD_prec_type = %s\n", str_solver_Nf2_MD_prec_type.c_str());
    vout.general(vl, "  solver_Nf2_H_prec_type  = %s\n", str_solver_Nf2_H_prec_type.c_str());
    vout.general(vl, "\n");

    //- input parameter check
    int err = 0;
    err += ParameterCheck::non_NULL(str_gconf_status);
    err += ParameterCheck::non_negative(i_conf);
    err += ParameterCheck::non_negative(Ntraj);
    err += ParameterCheck::non_negative(i_save_conf);

    if (err) {
      vout.crucial(vl, "Error at %s: input parameters have not been set\n", test_name.c_str());
      exit(EXIT_FAILURE);
    }

    // if ( (Nsmear > 0) && (str_proj_type == "Stout_SU3") ) {
    if (str_proj_type == "Stout_SU3") {
      if (CommonParameters::Nc() != 3) {
        vout.crucial(vl, "check skipped: Nc = 3 is needed, but Nc = %d.\n\n", CommonParameters::Nc());
        return EXIT_SKIP;
      }
    }


    RandomNumberManager::initialize(str_rand_type, seed);


    // #####  object setup  #####
    unique_ptr<Field_G> U(new Field_G(Nvol, Ndim));

    if (str_gconf_status == "Continue") {
      GaugeConfig(str_gconf_read).read(U, readfile);
    } else if (str_gconf_status == "Cold_start") {
      GaugeConfig("Unit").read(U);
    } else if (str_gconf_status == "Hot_start") {
      GaugeConfig("Random").read(U);
    } else {
      vout.crucial(vl, "Error at %s: unsupported gconf status \"%s\"\n", test_name.c_str(), str_gconf_status.c_str());
      exit(EXIT_FAILURE);
    }

    const unique_ptr<GaugeConfig> gconf_write(new GaugeConfig(str_gconf_write));


    unique_ptr<Action> action_G(Action::New(str_action_G_type));
    action_G->set_parameters(params_action_G);


    //-- smear part
    unique_ptr<Projection> proj(Projection::New(str_proj_type));
    proj->set_parameters(params_proj);

    unique_ptr<Smear> smear(Smear::New(str_smear_type, proj));
    smear->set_parameters(params_smear);

    unique_ptr<ForceSmear> force_smear(ForceSmear::New(str_smear_type, proj));
    force_smear->set_parameters(params_smear);

    unique_ptr<Director> dr_smear(new Director_Smear(smear));
    dr_smear->set_parameters(params_dr_smear);


    //-- N_f=2 part
    unique_ptr<Fopr> fopr_Nf2(Fopr::New(str_fopr_Nf2_type, str_gmset_type));
    fopr_Nf2->set_parameters(params_fopr_Nf2);

    unique_ptr<Force> force_fopr_Nf2(new Force_F_Clover_Nf2(str_gmset_type));
    force_fopr_Nf2->set_parameters(params_fopr_Nf2);

    unique_ptr<Fopr>  fopr_smear_Nf2(Fopr::New("Smeared", fopr_Nf2, dr_smear));
    unique_ptr<Force> force_fopr_smear_Nf2(new Force_F_Smeared(force_fopr_Nf2, force_smear, dr_smear));

    unique_ptr<Solver> solver_Nf2_MD(Solver::New(str_solver_Nf2_MD_type, fopr_smear_Nf2));
    solver_Nf2_MD->set_parameters(params_solver_Nf2_MD);
    unique_ptr<Fprop> fprop_Nf2_MD(new Fprop_Standard_lex(solver_Nf2_MD));

    unique_ptr<Solver> solver_Nf2_H(Solver::New(str_solver_Nf2_H_type, fopr_smear_Nf2));
    solver_Nf2_H->set_parameters(params_solver_Nf2_H);
    unique_ptr<Fprop> fprop_Nf2_H(new Fprop_Standard_lex(solver_Nf2_H));


    //-- N_f=2 part (preconditioner)
    unique_ptr<Fopr> fopr_Nf2_prec(Fopr::New(str_fopr_Nf2_prec_type, str_gmset_type));
    fopr_Nf2_prec->set_parameters(params_fopr_Nf2_prec);

    unique_ptr<Force> force_fopr_Nf2_prec(new Force_F_Clover_Nf2(str_gmset_type));
    force_fopr_Nf2_prec->set_parameters(params_fopr_Nf2_prec);

    unique_ptr<Fopr>  fopr_smear_Nf2_prec(Fopr::New("Smeared", fopr_Nf2_prec, dr_smear));
    unique_ptr<Force> force_fopr_smear_Nf2_prec(new Force_F_Smeared(force_fopr_Nf2_prec, force_smear, dr_smear));

    unique_ptr<Solver> solver_Nf2_MD_prec(Solver::New(str_solver_Nf2_MD_prec_type, fopr_smear_Nf2_prec));
    solver_Nf2_MD_prec->set_parameters(params_solver_Nf2_MD_prec);
    unique_ptr<Fprop> fprop_Nf2_MD_prec(new Fprop_Standard_lex(solver_Nf2_MD_prec));

    unique_ptr<Solver> solver_Nf2_H_prec(Solver::New(str_solver_Nf2_H_prec_type, fopr_smear_Nf2_prec));
    solver_Nf2_H_prec->set_parameters(params_solver_Nf2_H_prec);
    unique_ptr<Fprop> fprop_Nf2_H_prec(new Fprop_Standard_lex(solver_Nf2_H_prec));


    unique_ptr<Action> action_F_Nf2_prec(
      new Action_F_Standard_lex(fopr_smear_Nf2_prec, force_fopr_smear_Nf2_prec,
                                fprop_Nf2_MD_prec, fprop_Nf2_H_prec));

    unique_ptr<Action> action_F_Nf2_d(
      new Action_F_Ratio_lex(fopr_smear_Nf2_prec, force_fopr_smear_Nf2_prec,
                             fopr_smear_Nf2, force_fopr_smear_Nf2,
                             fprop_Nf2_H_prec,
                             fprop_Nf2_MD, fprop_Nf2_H));


    //-- N_f=1 part
    unique_ptr<Fopr> fopr_Nf1(Fopr::New(str_fopr_Nf1_type, str_gmset_type));
    fopr_Nf1->set_parameters(params_fopr_Nf1);

    //- NB. create Force_F_Nf2, then apply rational approximation
    unique_ptr<Force> force_fopr_Nf1(new Force_F_Clover_Nf2(str_gmset_type));
    force_fopr_Nf1->set_parameters(params_fopr_Nf1);

    //- NB. Langevin needs params_rational_H
    unique_ptr<Fopr> fopr_r1(Fopr::New("Rational", fopr_Nf1));
    fopr_r1->set_parameters(params_rational_H);
    unique_ptr<Fopr> fopr_smear_Nf1_langev(Fopr::New("Smeared", fopr_r1, dr_smear));

    //- NB. Hamiltonian needs params_rational_MD
    unique_ptr<Fopr> fopr_r2(Fopr::New("Rational", fopr_Nf1));
    fopr_r2->set_parameters(params_rational_MD);
    unique_ptr<Fopr> fopr_smear_Nf1_H(Fopr::New("Smeared", fopr_r2, dr_smear));

    unique_ptr<Force> force_fopr_Nf1_MD(new Force_F_Rational(fopr_Nf1, force_fopr_Nf1));
    force_fopr_Nf1_MD->set_parameters(params_rational_MD);
    unique_ptr<Force> force_fopr_smear_Nf1_MD(new Force_F_Smeared(force_fopr_Nf1_MD, force_smear, dr_smear));


    unique_ptr<Action> action_F_Nf1(
      new Action_F_Rational(fopr_smear_Nf1_langev, fopr_smear_Nf1_H, force_fopr_smear_Nf1_MD));


    ActionList actions(Nlevels);
    actions.append(level_action[0], action_F_Nf2_d);
    actions.append(level_action[1], action_F_Nf2_prec);
    actions.append(level_action[2], action_F_Nf1);
    actions.append(level_action[3], action_G);

    std::vector<Director *> directors(1);
    directors[0] = (Director *)dr_smear.get();

    const unique_ptr<Builder_Integrator> builder(new Builder_Integrator(actions, directors));
    builder->set_parameters(params_integrator);
    Integrator *integrator = builder->build();

    //- Random number is initialized with a parameter specified by i_conf
    unique_ptr<RandomNumbers> rand(new RandomNumbers_Mseries(i_conf));

    HMC_General hmc(actions, directors, integrator, rand);
    hmc.set_parameters(params_hmc);

    const unique_ptr<Timer> timer(new Timer(test_name));


    // ####  Execution main part  ####
    timer->start();

    vout.general(vl, "HMC start: Ntraj = %d\n", Ntraj);

    double result = 0.0;
    for (int traj = 0; traj < Ntraj; ++traj) {
      vout.general(vl, "\n");
      vout.general(vl, "---------------------------------------------------\n");
      vout.general(vl, "traj = %d\n", traj);

      result = hmc.update(*U);

      if ((i_conf + traj + 1) % i_save_conf == 0) {
        std::string filename = FileUtils::generate_filename("%s-%06d", writefile.c_str(), (i_conf + traj + 1));
        gconf_write->write_file(U, filename);
      }
    }

    gconf_write->write_file(U, writefile);

    timer->report();

    RandomNumberManager::finalize();


    if (do_check) {
      return Test::verify(result, expected_result);
    } else {
      vout.detailed(vl, "check skipped: expected_result not set.\n\n");
      return EXIT_SKIP;
    }
  }
} // namespace Test_HMC_Clover