woss-manager.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_MANAGER_DEFINITIONS_H
#define WOSS_MANAGER_DEFINITIONS_H
 
#if defined (WOSS_MULTITHREAD)
#include <set>
#include <map>
#include <thread>
#include <mutex>
#include <shared_mutex>
#include <condition_variable>
#endif // defined (WOSS_MULTITHREAD)
#include <utility>
#include <vector>
#include <memory>
#include <definitions-handler.h>
#include "woss-creator.h"
#include <woss-db-manager.h>
 
 
namespace woss {
 
  using CoordZPair = std::pair< CoordZ, CoordZ >;
 
  using CoordZPairVect = std::vector< CoordZPair >;
 
  using SimFreq = std::pair< double, double >;
  
  using SimFreqVector = std::vector< SimFreq >;
 
  using PressureVector = std::vector< std::unique_ptr<Pressure> >;
 
  using TimeArrVector = std::vector< std::unique_ptr<TimeArr> >;
 
  class WossManager {
 
    public:
 
    WossManager();
 
    virtual ~WossManager() = default;
 
    virtual std::shared_ptr<Woss> getActiveWoss( const CoordZ& tx, const CoordZ& rx, double start_frequency, double end_frequency );
 
    virtual WossManager& eraseActiveWoss( const CoordZ& tx, const CoordZ& rx, double start_frequency, double end_frequency ) = 0;
 
    virtual std::unique_ptr<Pressure> getWossPressure( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, const Time& time_value ) = 0;
 
    virtual std::unique_ptr<Pressure> getWossPressure( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, double time_value = 0.0 );
 
    virtual PressureVector getWossPressure( const CoordZPairVect& coordinates, double start_frequency, double end_frequency, const Time& time_value );
 
    virtual PressureVector getWossPressure( const CoordZPairVect& coordinates, double start_frequency, double end_frequency, double time_value = 0.0 );
 
    virtual std::unique_ptr<TimeArr> getWossTimeArr( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, const Time& time_value ) = 0;
 
    virtual std::unique_ptr<TimeArr> getWossTimeArr( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, double time_value = 0.0 );
 
    virtual TimeArrVector getWossTimeArr( const CoordZPairVect& coordinates, double start_frequency, double end_frequency, const Time& time_value );
 
    virtual TimeArrVector getWossTimeArr( const CoordZPairVect& coordinates, double start_frequency, double end_frequency, double time_value = 0.0 );
 
    virtual bool reset() = 0;
 
    virtual bool timeEvolve( const Time& time_value ) = 0;
 
    WossManager& setWossCreator( const std::shared_ptr<WossCreator>& ptr ) { woss_creator = ptr; return *this; }
 
    void setTimeEvolutionActiveFlag( bool flag ) { is_time_evolution_active = flag; }
 
    void setDebugFlag( bool flag ) { debug = flag; }
 
    std::shared_ptr<WossCreator> getWossCreator() const { return woss_creator; }
    
    bool getTimeEvolutionActiveFlag() const { return (bool)is_time_evolution_active; }
    
    bool getDebugFlag() const { return (bool)debug; }
 
    protected:
 
    static const Time NO_EVOLUTION_TIME;
 
    std::shared_ptr<WossCreator> woss_creator;
 
    bool debug;
 
    bool is_time_evolution_active;
 
    virtual std::shared_ptr<Woss> getWoss( const CoordZ& tx, const CoordZ& rx, double start_frequency, double end_frequency ) = 0;
 
  };
 
 
  class WossManagerResDb : public WossManager {
 
    public:
 
    WossManagerResDb();
 
    virtual ~WossManagerResDb() override = default;
 
    virtual std::unique_ptr<Pressure> getWossPressure( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, const Time& time_value ) override;
    
    virtual std::unique_ptr<TimeArr> getWossTimeArr( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, const Time& time_value ) override;
    
    WossManagerResDb& setWossDbManager( const std::shared_ptr<WossDbManager>& ptr ) { woss_db_manager = ptr; return *this; }
 
    protected:
 
    std::shared_ptr<WossDbManager> woss_db_manager;
 
    std::unique_ptr<TimeArr> dbGetTimeArr( const CoordZ& tx, const CoordZ& rx, double frequency, const Time& time_value ) const;
 
    void dbInsertTimeArr( const CoordZ& tx, const CoordZ& rx, double frequency, const Time& time_value, const TimeArr& channel ) const;
 
    std::unique_ptr<Pressure> dbGetPressure( const CoordZ& tx, const CoordZ& rx, double frequency, const Time& time_value ) const;
 
    void dbInsertPressure( const CoordZ& tx, const CoordZ& rx, double frequency, const Time& time_value, const Pressure& press ) const;
 
  };
 
  //inline functions
  inline void WossManagerResDb::dbInsertTimeArr( const CoordZ& tx, const CoordZ& rx, double frequency, const Time& time_value, const TimeArr& channel ) const {
    if ( woss_db_manager ) 
      woss_db_manager->insertTimeArr( tx, rx, frequency, time_value, channel ) ;
  }
 
  inline std::unique_ptr<TimeArr> WossManagerResDb::dbGetTimeArr( const CoordZ& tx, const CoordZ& rx, double frequency, const Time& time_value ) const {
    if ( woss_db_manager ) 
      return( woss_db_manager->getTimeArr( tx, rx, frequency, time_value ) );
    return( SDefHandler::instance().createTimeArr( TimeArr::createNotValid() ) );
  }
 
  inline void WossManagerResDb::dbInsertPressure( const CoordZ& tx, const CoordZ& rx, double frequency, const Time& time_value, const Pressure& press ) const {
    if ( woss_db_manager ) 
      woss_db_manager->insertPressure( tx, rx, frequency, time_value, press );
  }
 
  inline std::unique_ptr<Pressure> WossManagerResDb::dbGetPressure( const CoordZ& tx, const CoordZ& rx, double frequency, const Time& time_value ) const {
    if ( woss_db_manager ) 
      return( woss_db_manager->getPressure( tx, rx, frequency, time_value ) );
    return(SDefHandler::instance().createPressure( Pressure::createNotValid()));
  }
 
#ifdef WOSS_MULTITHREAD
  static constexpr inline int MAX_TOTAL_THREADS = 32;
 
  class WossManagerResDbMT : public WossManagerResDb {
 
    public:
 
    WossManagerResDbMT();
    
    virtual ~WossManagerResDbMT() override = default;
 
    virtual std::unique_ptr<Pressure> getWossPressure( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, const Time& time_value ) override;
    
    virtual std::unique_ptr<Pressure> getWossPressure( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, double time_value ) override;
 
 
    virtual std::unique_ptr<TimeArr> getWossTimeArr( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, const Time& time_value ) override;
 
    virtual std::unique_ptr<TimeArr> getWossTimeArr( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, double time_value ) override;
    
    
    virtual PressureVector getWossPressure( const CoordZPairVect& coordinates, double start_frequency, double end_frequency, const Time& time_value ) override;
        
    virtual PressureVector getWossPressure( const CoordZPairVect& coordinates, double start_frequency, double end_frequency, double time_value ) override;
            
    virtual TimeArrVector getWossTimeArr( const CoordZPairVect& coordinates, double start_frequency, double end_frequency, const Time& time_value ) override;
 
    virtual TimeArrVector getWossTimeArr( const CoordZPairVect& coordinates, double start_frequency, double end_frequency, double time_value ) override;
    
    void setConcurrentThreads( unsigned int number ) { concurrent_threads = number; checkConcurrentThreads(); }
 
    unsigned int getConcurrentThreads() const { return concurrent_threads; }
 
    void setUseThreadPoolFlag (bool flag ) { use_thread_pool = flag; }
 
    bool getUseThreadPoolFlag() { return use_thread_pool; }
 
    protected:
 
    struct ThreadCondSignal {
      std::mutex mutex;
      std::condition_variable condition;
    };
 
    using ActiveWoss = std::map< std::shared_ptr<Woss>, std::unique_ptr<ThreadCondSignal> >;
    using AWIter = ActiveWoss::iterator;
    using AWRIter = ActiveWoss::reverse_iterator;
    using AWCIter = ActiveWoss::const_iterator;
    using AWCRIter = ActiveWoss::const_reverse_iterator;
 
    unsigned int max_thread_number;
 
    unsigned int concurrent_threads;
 
    std::mutex request_mutex;
 
    ActiveWoss active_woss;
 
    bool use_thread_pool;
    
    void checkConcurrentThreads();
  };
 
#endif // WOSS_MULTITHREAD
 
}
 
#endif /* WOSS_MANAGER_DEFINITIONS_H */