sediment-definitions.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_SEDIMENT_DEFINITIONS_H
#define WOSS_SEDIMENT_DEFINITIONS_H
 
 
#include <utility>
#include <string>
#include <memory>
#include <ostream>
 
namespace woss {
 
  static constexpr inline double SEDIMENT_NOT_SET_VALUE = (-10000.0);
 
  using Deck41Types = std::pair < int , int >;
 
  class Sediment {
 
    public:
 
    Sediment();
 
    Sediment( const std::string& name, double velc, double vels, double dens, double attc, double atts, double bottom_depth = 1.0 );
 
    Sediment( const Sediment& copy ) = default;
 
    Sediment( Sediment&& tmp ) = default;
 
    virtual ~Sediment() = default;
 
     virtual std::unique_ptr<Sediment> create() const {
      return std::make_unique<Sediment>(); }
 
    virtual std::unique_ptr<Sediment> create( const std::string& name, double velc, double vels, double dens, double attc, double atts, double bottom_depth = 1.0 ) const {
      return std::make_unique<Sediment>( name, velc, vels, dens, attc, atts, bottom_depth); }
 
    virtual std::unique_ptr<Sediment> clone() const { return std::make_unique<Sediment>(*this); }
 
    Sediment& setType( const std::string& name ) { type = name; return *this; }
 
    Sediment& setVelocityC( double vel  ) { vel_c = vel; return *this; }
 
    Sediment& setVelocityS( double vel ) { vel_s = vel; return *this; }
 
    Sediment& setDensity( double dens ) { density = dens; return *this; }
 
    Sediment& setAttenuationC( double att ) { att_c = att; return *this; }
 
    Sediment& setAttenuationS( double att ) { att_s = att; return *this; }
 
    Sediment& setDepth( double bottom_depth ) { depth = bottom_depth; return *this; }
 
    Sediment& set( const std::string& name, double velc, double vels, double dens, double attc , double atts, double bottom_depth ) { 
                        type = name; vel_c = velc; vel_s = vels, density = dens;
                        att_c = attc; att_s = atts; depth = bottom_depth; return *this; }
 
    static void setDebug( bool flag ) { debug = flag; } 
 
    double getVelocityC() const { return vel_c; }
 
    double getVelocityS() const { return vel_s; }
 
    double getDensity() const { return density; }
 
    double getAttenuationC() const { return att_c; }
 
    double getAttenuationS() const { return att_s; }
 
    double getDepth() const { return depth; }
 
    std::string getType() const { return type; }
 
    virtual bool isValid() const { return ( vel_c != SEDIMENT_NOT_SET_VALUE && vel_s != SEDIMENT_NOT_SET_VALUE && density != SEDIMENT_NOT_SET_VALUE
                                        && att_c != SEDIMENT_NOT_SET_VALUE && att_s != SEDIMENT_NOT_SET_VALUE ); }
 
    virtual const std::string getStringValues() const;
 
    Sediment& operator=( const Sediment& sed ) = default;
 
    Sediment& operator=( Sediment&& tmp ) = default;
 
    friend const Sediment operator+( const Sediment& left, const Sediment& right );
 
    friend const Sediment operator-( const Sediment& left, const Sediment& right );
 
    friend const Sediment operator/( const Sediment& left, const Sediment& right );
 
    friend const Sediment operator*( const Sediment& left, const Sediment& right );
 
    friend Sediment& operator+=( Sediment& left, const Sediment& right );
 
    friend Sediment& operator-=( Sediment& left, const Sediment& right );
 
    friend Sediment& operator/=( Sediment& left, const Sediment& right );
 
    friend Sediment& operator*=( Sediment& left, const Sediment& right );
    
    
    friend Sediment& operator+=( Sediment& left, double right );
 
    friend Sediment& operator-=( Sediment& left, double right );
 
    friend Sediment& operator/=( Sediment& left, double right );
 
    friend Sediment& operator*=( Sediment& left, double right );
 
    friend bool operator==( const Sediment& left, const Sediment& right );
 
    friend bool operator!=( const Sediment& left, const Sediment& right );
 
    friend const Sediment operator+( const double left, const Sediment& right );
  
    friend const Sediment operator-( const double left, const Sediment& right );
    
    friend const Sediment operator/( const double left, const Sediment& right );
 
    friend const Sediment operator*( const double left, const Sediment& right );
 
    friend const Sediment operator+( const Sediment& left, double right );
 
    friend const Sediment operator-( const Sediment& left, double right );
 
    friend const Sediment operator/( const Sediment& left, double right );
 
    friend const Sediment operator*( const Sediment& left, double right );
 
    friend std::ostream& operator<<( std::ostream& os, const Sediment& instance );
 
    protected:
 
    std::string type;
 
    double depth;
 
    double vel_c;
 
    double vel_s; 
 
    double density;
 
    double att_c; 
 
    double att_s; 
 
    static bool debug;
 
  };
 
  // non-inline friend operator declarations
  const Sediment operator/( const double left, const Sediment& right );
 
  const Sediment operator*( const double left, const Sediment& right );
 
  const Sediment operator/( const Sediment& left, const double right );
    
  const Sediment operator*( const Sediment& left, const double right );
 
 
  Sediment& operator+=( Sediment& left, const Sediment& right );
 
  Sediment& operator-=( Sediment& left, const Sediment& right );
 
  Sediment& operator/=( Sediment& left, const Sediment& right );
 
  Sediment& operator*=( Sediment& left, const Sediment& right );
 
 
  Sediment& operator+=( Sediment& left, double right );
 
  Sediment& operator-=( Sediment& left, double right );
 
  Sediment& operator/=( Sediment& left, double right );
 
  Sediment& operator*=( Sediment& left, double right );
 
  //inline functions
  inline bool operator==( const Sediment& left, const Sediment& right ) {
    if ( &left == &right ) 
      return true; 
    return( left.vel_c == right.vel_c && left.vel_s == right.vel_s && left.att_c == right.att_c && left.att_s == right.att_s
        && left.density == right.density );
  }
 
  inline bool operator!=( const Sediment& left, const Sediment& right ) {
    if ( &left == &right ) 
      return false; 
    return( left.vel_c != right.vel_c || left.vel_s != right.vel_s || left.att_c != right.att_c || left.att_s != right.att_s
        || left.density != right.density );
  }
 
  inline std::ostream& operator<<(std::ostream& os, const Sediment& instance ) {
    os << "Sediment type = " << instance.type << "; velocity_c = " << instance.vel_c << "; velocity_s = " << instance.vel_s << "; density = " << instance.density
       << "; attenuation_c = " << instance.att_c << "; attenuation_s = " << instance.att_s;
    return os;
  }
 
  inline const Sediment operator+( const Sediment& left, const Sediment& right ) {
    return( Sediment( left.type + " + " + right.type, left.vel_c + right.vel_c, left.vel_s + right.vel_s, left.density + right.density, left.att_c + right.att_c, left.att_s + right.att_s ) );
  }
 
  inline const Sediment operator-( const Sediment& left, const Sediment& right ) {
    return( Sediment( left.type + " - " + right.type, left.vel_c - right.vel_c, left.vel_s - right.vel_s, left.density - right.density, left.att_c - right.att_c, left.att_s - right.att_s ) );
  }
 
  inline const Sediment operator/( const Sediment& left, const Sediment& right ) {
    return( Sediment( left.type + " / " + right.type, left.vel_c / right.vel_c, left.vel_s / right.vel_s, left.density / right.density, left.att_c / right.att_c, left.att_s / right.att_s ) );
  }
 
  inline const Sediment operator*( const Sediment& left, const Sediment& right ) {
    return( Sediment( left.type + " * " + right.type, left.vel_c * right.vel_c, left.vel_s * right.vel_s, left.density * right.density, left.att_c * right.att_c, left.att_s * right.att_s ) );
  }
    
  class SedimentGravel : public Sediment {
 
    public:
 
    SedimentGravel(double depth = 1.0);
 
    protected:
 
    double calculateVelocityS(double vels, double bottom_depth) const;
 
  };
 
 
  class SedimentSand : public Sediment {
 
    public:
 
    SedimentSand();
 
  };
 
 
  class SedimentSilt : public Sediment {
 
    public:
 
    SedimentSilt(double depth = 1.0);
 
    protected:
 
    double calculateVelocityS(double vels, double bottom_depth) const;
 
  };
 
 
  class SedimentClay : public Sediment {
 
    public:
 
    SedimentClay();
 
  };
 
 
  class SedimentOoze : public Sediment {
 
    public:
 
    SedimentOoze();
 
  };
 
 
  class SedimentMud : public Sediment {
 
    public:
 
    SedimentMud(double depth = 1.0);
 
    protected:
 
    double calculateVelocityS(double vels, double bottom_depth) const;
 
  };
 
 
  class SedimentRocks : public Sediment {
 
    public:
 
    SedimentRocks();
 
  };
 
 
  class SedimentOrganic : public Sediment {
 
    public:
 
    SedimentOrganic();
 
  };
 
 
  class SedimentNodules : public Sediment {
 
    public:
 
    SedimentNodules();
 
  };
 
 
  class SedimentHardBottom : public Sediment {
 
    public:
 
    SedimentHardBottom();
 
  };
 
}
 
#endif /* WOSS_SEDIMENT_DEFINITIONS_H */