particles.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_PARTICLES_HPP_INCLUDED_
#define TRIUMVIRATE_INCLUDE_PARTICLES_HPP_INCLUDED_
 
#include <algorithm>
#include <cmath>
#include <cstddef>
#include <cstdio>
#include <fstream>
#include <iterator>
#include <sstream>
#include <string>
#include <vector>
 
#include "monitor.hpp"

#ifdef __GNUC__
#define PURE __attribute__((pure))
#else
#define PURE
#endif
 
namespace trv {

struct ParticleData {
  double pos[3];  
  double nz;      
  double ws;      
  double wc;      
  double w;       
};

class ParticleCatalogue {
 public:
  std::string source;  
 
  ParticleData* pdata = nullptr;  
 
  int ntotal = 0;       
  double wtotal = 0.;   
  double wstotal = 0.;  
 
  double pos_min[3] = {0., 0., 0.};   
  double pos_max[3] = {0., 0., 0.};   
  double pos_span[3] = {0., 0., 0.};  
 
  // ---------------------------------------------------------------------
  // Life cycle
  // ---------------------------------------------------------------------

  explicit ParticleCatalogue(int verbose = -1);

  ~ParticleCatalogue();

  void initialise_particles(const int num);

  void finalise_particles();

  void reset_particles();
 
  // ---------------------------------------------------------------------
  // Operators & reserved methods
  // ---------------------------------------------------------------------

  PURE ParticleData& operator[](const int pid);
 
  // ---------------------------------------------------------------------
  // Data I/O
  // ---------------------------------------------------------------------

  int load_catalogue_file(
    const std::string& catalogue_filepath,
    const std::string& catalogue_columns,
    const std::string& catalogue_dataset = "",
    double volume = 0.
  );

  int load_particle_data(
    std::vector<double> x, std::vector<double> y, std::vector<double> z,
    std::vector<double> nz, std::vector<double> ws, std::vector<double> wc
  );
 
  // ---------------------------------------------------------------------
  // Catalogue properties
  // ---------------------------------------------------------------------

  void calc_total_weights();

  void calc_pos_extents(bool init = true);
 
  // ---------------------------------------------------------------------
  // Catalogue operations
  // ---------------------------------------------------------------------

  void offset_coords(const double dpos[3]);

  void offset_coords_for_periodicity(const double boxsize[3]);

  static void centre_in_box(
    ParticleCatalogue& catalogue,
    const double boxsize[3]
  );

  static void centre_in_box(
    ParticleCatalogue& catalogue, ParticleCatalogue& catalogue_ref,
    const double boxsize[3]
  );

  static void pad_in_box(
    ParticleCatalogue& catalogue,
    const double boxsize[3], const double boxsize_pad[3]
  );

  static void pad_in_box(
    ParticleCatalogue& catalogue, ParticleCatalogue& catalogue_ref,
    const double boxsize[3], const double boxsize_pad[3]
  );

  static void pad_grids(
    ParticleCatalogue& catalogue,
    const double boxsize[3], const int ngrid[3], const double ngrid_pad[3]
  );

  static void pad_grids(
    ParticleCatalogue& catalogue, ParticleCatalogue& catalogue_ref,
    const double boxsize[3], const int ngrid[3], const double ngrid_pad[3]
  );
};
 
}  // namespace trv
 
#endif  // !TRIUMVIRATE_INCLUDE_PARTICLES_HPP_INCLUDED_