parameters.hpp

Go to the documentation of this file.

// Triumvirate: Three-Point Clustering Measurements in LSS
//
// Copyright (C) 2023 Mike S Wang & Naonori S Sugiyama [GPL-3.0-or-later]
//
// This file is part of the Triumvirate program. See the COPYRIGHT
// and LICENCE files at the top-level directory of this distribution
// for details of copyright and licensing.
//
// 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 3 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, see <https://www.gnu.org/licenses/>.

 
#ifndef TRIUMVIRATE_INCLUDE_PARAMETERS_HPP_INCLUDED_
#define TRIUMVIRATE_INCLUDE_PARAMETERS_HPP_INCLUDED_
 
#include <sys/stat.h>
 
#include <fftw3.h>
 
#include <algorithm>
#include <cmath>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <fstream>
#include <string>
 
#include "monitor.hpp"
 
namespace trv {

class ParameterSet {
 public:
  // ---------------------------------------------------------------------
  // I/O
  // ---------------------------------------------------------------------

  std::string catalogue_dir;
  std::string measurement_dir;
  std::string data_catalogue_file;
  std::string rand_catalogue_file;
  std::string catalogue_columns;
  std::string catalogue_dataset;
  std::string output_tag;
 
  // ---------------------------------------------------------------------
  // Mesh sampling
  // ---------------------------------------------------------------------
 
  // Mesh properties.
  double boxsize[3] = {0., 0., 0.};
  int ngrid[3] = {0, 0, 0};
  double expand = 1.;
  double cutoff_nyq = 0.;  
 
  // Mesh alignment.
  std::string alignment = "centre";
  std::string padscale = "box";
  double padfactor = 0.;
 
  // Mesh assignment.
  std::string assignment = "tsc";
  std::string interlace = "false";
 
  // Derived mesh quantities.
  double volume = 0.;  
  long long nmesh;     
 
  int assignment_order = 0;  
 
  // ---------------------------------------------------------------------
  // Measurement
  // ---------------------------------------------------------------------
 
  // Measurement type.
  std::string catalogue_type;
  std::string statistic_type;
 
  // Derived measurement type.
  std::string npoint;  
  std::string space;   
 
  // Measurement indexing.
  int ell1 = 0;
  int ell2 = 0;
  int ELL = 0;
 
  int i_wa = 0;  
  int j_wa = 0;  
 
  // Measurement choices.
  std::string form = "diag";

  std::string norm_convention = "particle";
 
  // Derived measurement choices.
  std::string shape = "diag";
 
  // Measurement parameters.
  std::string binning = "lin";
 
  double bin_min = 0.;  
  double bin_max = 0.;  

  int num_bins = 0;
  int idx_bin = 0;
 
  // ---------------------------------------------------------------------
  // Misc
  // ---------------------------------------------------------------------

  std::string fftw_scheme = "measure";

  unsigned fftw_planner_flag = FFTW_MEASURE;

  std::string use_fftw_wisdom = "false";

  std::string fftw_wisdom_file_f;  
  std::string fftw_wisdom_file_b;  

  std::string save_binned_vectors = "false";

  int verbose = 20;

  std::string progbar = "false";

  ParameterSet() = default;

  ~ParameterSet() = default;

  ParameterSet(const ParameterSet& other);

  int read_from_file(char* parameter_filepath);

  int validate(bool init = false);

  int print_to_file(char* out_parameter_filepath);

  int print_to_file();
 
 private:
   std::vector<std::string> data_catalogue_files;
   std::vector<std::string> rand_catalogue_files;
};

void override_paramset_by_envvars(trv::ParameterSet& params);

void set_boxsize_from_expand(
  const double* spans, trv::ParameterSet& params
);

void set_ngrid_from_cutoff(trv::ParameterSet& params);
 
}  // namespace trv
 
#endif  // !TRIUMVIRATE_INCLUDE_PARAMETERS_HPP_INCLUDED_