woss.h

Go to the documentation of this file.

/* WOSS - World Ocean Simulation System -
 * 
 * Copyright (C) 2009 2025 Federico Guerra
 * and regents of the SIGNET lab, University of Padova
 *
 * Author: Federico Guerra - WOSS@guerra-tlc.com
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */ 
 
#ifndef WOSS_PROGRAM_DEFINITIONS_H
#define WOSS_PROGRAM_DEFINITIONS_H
 
 
#include <set>
#include <map>
#include <climits>
#ifdef WOSS_MULTITHREAD
#include <atomic>
#endif // WOSS_MULTITHREAD
#include <coordinates-definitions.h>
#include <time-definitions.h>
#include <pressure-definitions.h>
#include <time-arrival-definitions.h>
#include "res-reader.h"
 
 
namespace woss {
 
  class WossDbManager;
 
  using FreqSet = std::set< double >;
  using FreqSIt = FreqSet::iterator;
  using FreqSCIt = FreqSet::const_iterator;
  using FreqSRIt = FreqSet::reverse_iterator;
  using FreqSCRIt = FreqSet::const_reverse_iterator;
 
  static constexpr inline int WOSS_MIN_DEPTH = 0;            
  static constexpr inline int WOSS_MAX_DEPTH = INT_MAX;      
  static constexpr inline int WOSS_MIN_RANGE = -INT_MAX;     
  static constexpr inline int WOSS_MAX_RANGE = INT_MAX;      
  class Woss {
 
    public:
 
    Woss();
 
    Woss( const CoordZ& tx, const CoordZ& rx, const Time& start_t, const Time& end_t, double start_freq, double end_freq, double freq_step ) ;
 
    virtual ~Woss();
 
    virtual bool initialize() = 0;
 
    virtual bool run() = 0;
 
    virtual bool timeEvolve( const Time& time_value ) = 0;
 
    virtual bool isValid() const = 0;
 
    virtual std::unique_ptr<Pressure> getAvgPressure( double frequency, double tx_depth, double start_rx_depth = WOSS_MIN_DEPTH, double start_rx_range = WOSS_MIN_RANGE, double end_rx_depth = WOSS_MAX_DEPTH , double end_rx_range = WOSS_MAX_RANGE ) const = 0;
 
    virtual std::unique_ptr<Pressure> getPressure( double frequency, double tx_depth, double rx_depth, double rx_range ) const = 0;
  
    virtual std::unique_ptr<TimeArr> getTimeArr( double frequency, double tx_depth, double rx_depth, double rx_range ) const = 0;
 
    Woss& setDebug( bool flag ) { debug = flag; return *this; }
 
    Woss& setCleanWorkDir( bool flag ) { clean_workdir = flag; return *this; }
 
    Woss& setWorkDirPath( const std::string& path ) { work_dir_path = path; return *this; }
 
    Woss& setWossDbManager( const std::shared_ptr<WossDbManager>& ptr ) { db_manager = ptr; return *this; }
 
    Woss& insertFrequency( double freq ) { frequencies.emplace(freq); return *this; } 
 
    Woss& insertFrequencies( double freq_start, double freq_end, double freq_step );
 
    Woss& setFrequencies( const FreqSet& freq_set ) { frequencies = freq_set; return *this; }
 
    Woss& eraseFrequency( double freq ) { frequencies.erase(freq); return *this; }
 
    Woss& clearFrequencies() { frequencies.clear(); return *this; }
 
    Woss& setTotalRuns( int runs ) { total_runs = runs; return *this; }
 
    Woss& setTxCoordZ( const CoordZ& coordz ) { tx_coordz = coordz; return *this; }
 
    Woss& setRxCoordZ( const CoordZ& coordz ) { rx_coordz = coordz; return *this; }
 
    Woss& setStartTime( const Time& start_t ) { start_time = start_t; return *this; }
 
    Woss& setEndTime( const Time& end_t ) { end_time = end_t; return *this; }  
 
    Woss& setEvolutionTimeQuantum( double value ) { evolution_time_quantum = value; return *this; } 
 
    int getWossId() const { return woss_id; }
 
    std::string getWorkDirPath() const { return work_dir_path; }
 
    const FreqSet& getFrequencies() const { return frequencies; }
 
    double getMinFrequency() const { return( *( frequencies.begin() ) ); }
 
    double getMaxFrequency() const { return( *( frequencies.rbegin() ) ); } 
 
    FreqSCIt freq_begin() const { return( frequencies.begin() ); } 
 
    FreqSCIt freq_end() const { return( frequencies.end() ); } 
    
    FreqSCRIt freq_rbegin() const { return( frequencies.rbegin() ); }
 
    FreqSCRIt freq_rend() const { return( frequencies.rend() ); }
 
    FreqSCIt freq_lower_bound( double frequency ) const { return( frequencies.lower_bound( frequency ) ); } 
 
    FreqSCIt freq_upper_bound( double frequency ) const { return( frequencies.upper_bound( frequency ) ); } 
 
    int getTotalRuns() const { return total_runs; }
 
    CoordZ getTxCoordZ() const { return tx_coordz; }
  
    CoordZ getRxCoordZ() const { return rx_coordz; }
 
    Time getStartTime() const { return start_time; }
 
    Time getCurrentTime() const { return current_time; }
 
    Time getEndTime() const { return end_time; } 
 
    double getEvolutionTimeQuantum() const { return evolution_time_quantum; }
 
    double getGreatCircleDistance() const { return total_great_circle_distance; }
 
    double getDistance() const { return total_distance; }
 
    double getBearing() const { return bearing; }
 
    bool usingDebug() const { return debug; }
 
    virtual bool isRunning() const;
 
    protected:
 
#if defined (WOSS_MULTITHREAD)
    static std::atomic<int> woss_counter;
#else
   static int woss_counter;
#endif // defined (WOSS_MULTITHREAD)
    int woss_id;
 
    std::string work_dir_path;
 
    std::shared_ptr<WossDbManager> db_manager;
 
    Time start_time;
 
    Time current_time;
 
    Time end_time;
 
    double evolution_time_quantum;
 
    CoordZ tx_coordz;
 
    CoordZ rx_coordz;
 
    FreqSet frequencies;
 
    double bearing;
 
    double total_great_circle_distance;
 
    double total_distance;
 
    int total_runs;
 
    bool debug;
 
#if defined (WOSS_MULTITHREAD)
    std::atomic<bool> has_run_once;
 
    std::atomic<bool> is_running;
#else
    bool has_run_once;
 
    volatile bool is_running;
#endif // defined (WOSS_MULTITHREAD)
 
    bool clean_workdir;
 
    virtual bool mkWorkDir( double curr_frequency, int curr_run = 0 );
 
    virtual bool rmWorkDir( double curr_frequency, int curr_run = 0 );
 
    virtual bool rmWorkDir();
 
  };
 
  using ResReaderMap = std::map< double, std::unique_ptr<ResReader> >;
  using RRMIter = ResReaderMap::iterator;
  using RRMRIter = ResReaderMap::reverse_iterator;
  using RRMCIter = ResReaderMap::const_iterator;
  using RRMCRIter = ResReaderMap::const_reverse_iterator;
  using RRMPair = std::pair< RRMIter, bool >;
 
 
  class WossResReader : public Woss { 
 
    public: 
    
    WossResReader() = default;
 
    WossResReader( const CoordZ& tx, const CoordZ& rx, const Time& start_t, const Time& end_t, 
                  double start_freq, double end_freq, double freq_step ) 
                  : Woss( tx, rx, start_t, end_t, start_freq, end_freq, freq_step ) { }
 
    virtual ~WossResReader() override = default;
 
    virtual bool initResReader( double curr_frequency ) = 0;
 
    protected:
 
    ResReaderMap res_reader_map;
 
    void clearResReaderMap();
 
  };
 
}
 
#endif /* WOSS_PROGRAM_DEFINITIONS_H */