ac-toolbox-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 AC_TOOLBOX_WOSS_DEFINITIONS_H
#define AC_TOOLBOX_WOSS_DEFINITIONS_H
 
 
#include <vector>
#include <map>
#include <set>
#include <memory>
#include <ssp-definitions.h>
#include <altimetry-definitions.h>
#include "woss.h"
 
 
namespace woss {
 
  class Sediment;
 
  using RangeVector = std::vector< double >;
 
  using SSPMap = std::map< int, std::unique_ptr<SSP> >;
 
  using SedimentMap = std::map< int, std::unique_ptr<Sediment> >;
 
  class ACToolboxWoss : public WossResReader {
 
    public:
 
    ACToolboxWoss();
 
    ACToolboxWoss( const CoordZ& tx, const CoordZ& rx, const Time& start_t, const Time& end_t, double start_freq, double end_freq, double freq_step );
 
    virtual ~ACToolboxWoss() override = default;
 
    virtual bool initialize() override;
 
    virtual bool isValid() const override;
 
    ACToolboxWoss& setRangeSteps( int steps ) { total_range_steps = steps; coordz_vector.reserve(steps + 2); 
                                      range_vector.reserve(steps + 2); return *this; }
 
    ACToolboxWoss& setSSPDepthPrecision( long double precision ) { ssp_depth_precision = precision; return *this; }
 
    int getRangeSteps() const { return total_range_steps; }
 
    long double getSSPDepthPrecision() const { return ssp_depth_precision; }
 
    int getMinSSPDepthSteps() const { return min_ssp_depth_steps; }
 
    int getMaxSSPDepthSteps() const { return max_ssp_depth_steps; }
 
    double getMinSSPDepth() const { return( *(min_ssp_depth_set.begin()) ); }
 
    double getMaxSSPDepth() const { return( *(max_ssp_depth_set.rbegin()) ); }
 
    double getMinBathymteryDepth() const { return min_bathymetry_depth; }
 
    double getMaxBathymetryDepth() const { return max_bathymetry_depth; }
 
    protected:
 
    long double ssp_depth_precision;
 
    double min_bathymetry_depth;
 
    double max_bathymetry_depth;
 
    double min_altimetry_depth;
 
    double max_altimetry_depth;
 
    std::set< double > min_ssp_depth_set;
 
    std::set< double > max_ssp_depth_set;
 
    int min_ssp_depth_steps;
 
    int max_ssp_depth_steps;
 
    int total_range_steps;
 
    CoordZVector coordz_vector;
 
    RangeVector range_vector;
 
    SSPMap ssp_map;
 
    SedimentMap sediment_map;
 
    std::unique_ptr<Altimetry> altimetry_value;
 
    bool is_ssp_map_transformable;
 
    virtual bool checkSSPUnicity( const SSP& ptr ) const;
 
    virtual bool checkSedimentUnicity( const Sediment& ptr ) const;
 
    virtual bool initRangeVector();
 
    virtual bool initCoordZVector();
    
    virtual bool initSedimentMap();
 
    virtual void resetSedimentMap(); 
 
    virtual bool initAltimetry();
        
    virtual bool initSSPMap();
 
    virtual void resetSSPMap(); 
 
  };
 
}
 
#endif /* AC_TOOLBOX_WOSS_DEFINITIONS_H */