AnisoSurfaceWaveSynthetic.h

Go to the documentation of this file.

#ifndef ANISOSURFACEWAVESYNTHETIC_H_
#define ANISOSURFACEWAVESYNTHETIC_H_

#include "ParkSurfaceWaveData.h"
#include "AnisoSurfaceWaveModel.h"
#include <string>
#include <boost/shared_ptr.hpp>
#include "types.h"

namespace gplib
  {
    /** \addtogroup seistools Seismic data analysis and modeling */
    /* @{ */

    //! Calculate synthetic anisotropic surface wave data
    class AnisoSurfaceWaveSynthetic
      {
    private:
      AnisoSurfaceWaveModel Model;
      ParkSurfaceWaveData SynthData;
    public:
      //! Return the synthetic data calculated during the last calculation
      const ParkSurfaceWaveData &GetSynthData() const
        {
          return SynthData;
        }
      //! Read-only access to the model
      const AnisoSurfaceWaveModel &GetModel() const
        {
          return Model;
        }
      //! Set the model for the forward calculation
      void SetModel(const AnisoSurfaceWaveModel &m)
        {
          Model = m;
        }
      //! Write the model to a file with name filename
      void WriteModel(const std::string &filename) const
        {
          Model.WriteModel(filename);
        }
      //! Write the model to a file with name filename for plotting
      void WritePlot(const std::string &filename) const
        {
          Model.WritePlot(filename);
        }
      //! Perform actions for forward modeling that have to be done before a parallel section
      void PreParallel(const std::string &filename);
      //! Perform actions for forward modeling that can safely done in parallel, filename should be unique to ensure safe parallel execution
      ParkSurfaceWaveData SafeParallel(const std::string &filename);
      //! Calculate the synthetic data for the current model, filename should be unique to ensure safe parallel execution
      ParkSurfaceWaveData GetSynthData(const std::string &filename);
      AnisoSurfaceWaveSynthetic();
      virtual ~AnisoSurfaceWaveSynthetic();
      };
  /* @} */
  }
#endif /*ANISOSURFACEWAVESYNTHETIC_H_*/