FlowSieve  3.4.0
FlowSieve Coarse-Graining Documentation
dataset Class Reference

Class to store main variables. More...

#include <functions.hpp>

Public Member Functions

void load_time (const std::string dim_name, const std::string filename)
 
void load_depth (const std::string dim_name, const std::string filename)
 
void load_latitude (const std::string dim_name, const std::string filename)
 
void load_longitude (const std::string dim_name, const std::string filename)
 
void compute_cell_areas ()
 
void load_variable (const std::string var_name, const std::string var_name_in_file, const std::string filename, const bool read_mask=true, const bool load_counts=true, const bool do_splits=true)
 
void load_region_definitions (const std::string filename, const std::string dim_name, const std::string var_name, const MPI_Comm=MPI_COMM_WORLD)
 
void compute_region_areas ()
 
void prepare_for_coarsened_grids (const std::string filename, const MPI_Comm=MPI_COMM_WORLD)
 
void check_processor_divisions (const int Nprocs_in_time_input, const int Nprocs_in_depth_input, const MPI_Comm=MPI_COMM_WORLD)
 
void gather_variable_across_depth (const std::vector< double > &var, std::vector< double > &gathered_var) const
 
void gather_mask_across_depth (const std::vector< bool > &var, std::vector< bool > &gathered_var) const
 
size_t local_index (const int Itime, const int Idepth, const int Ilat, const int Ilon) const
 
size_t global_index (const int Itime, const int Idepth, const int Ilat, const int Ilon, const std::string merge_kind) const
 
size_t index_local_to_global (const size_t index, const std::string merge_kind) const
 
size_t index_global_to_local (const size_t index, const std::string merge_kind) const
 
void index1to4_local (const size_t index, int &Itime, int &Idepth, int &Ilat, int &Ilon) const
 
void index1to4_global (const size_t index, int &Itime, int &Idepth, int &Ilat, int &Ilon, const std::string merge_kind) const
 

Public Attributes

int Nprocs_in_time
 
int Nprocs_in_depth
 
std::vector< double > time
 
std::vector< double > depth
 
std::vector< double > latitude
 
std::vector< double > longitude
 
int Ntime = -1
 
int Ndepth = -1
 
int Nlat = -1
 
int Nlon = -1
 
int full_Ntime = -1
 
int full_Ndepth = -1
 
MPI_Comm MPI_Comm_Global = MPI_COMM_WORLD
 
MPI_Comm MPI_subcomm_sametimes
 
MPI_Comm MPI_subcomm_samedepths
 
std::vector< double > areas
 
bool compute_radial_vel = false
 
bool use_depth_derivatives = false
 
bool depth_is_elevation = false
 
bool depth_is_increasing = true
 
std::map< std::string, std::vector< double > > variables
 
std::vector< std::string > region_names
 
std::map< std::string, std::vector< bool > > regions
 
std::vector< double > region_areas
 
std::vector< double > region_areas_water_only
 
std::vector< double > coarse_map_lat
 
std::vector< double > coarse_map_lon
 
std::vector< double > coarse_map_areas
 
std::vector< bool > mask
 
std::vector< bool > reference_mask
 
std::vector< bool > mask_DEPTH
 
std::vector< int > myCounts
 
std::vector< int > myStarts
 

Detailed Description

Class to store main variables.

This class is used to hold the various source data variables such as velocity components, mask, region definitions, density, etc


The documentation for this class was generated from the following files: