CrustalProfile.h

Go to the documentation of this file.

//- ****************************************************************************
//-
//- Copyright 2009 National Technology & Engineering Solutions of Sandia, LLC
//- (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
//- Government retains certain rights in this software.
//-
//- BSD Open Source License
//- All rights reserved.
//-
//- Redistribution and use in source and binary forms, with or without
//- modification, are permitted provided that the following conditions are met:
//-
//-   1. Redistributions of source code must retain the above copyright notice,
//-      this list of conditions and the following disclaimer.
//-
//-   2. Redistributions in binary form must reproduce the above copyright
//-      notice, this list of conditions and the following disclaimer in the
//-      documentation and/or other materials provided with the distribution.
//-
//-   3. Neither the name of the copyright holder nor the names of its
//-      contributors may be used to endorse or promote products derived from
//-      this software without specific prior written permission.
//-
//- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
//- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
//- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
//- ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
//- LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
//- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
//- SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
//- INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
//- CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
//- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//- POSSIBILITY OF SUCH DAMAGE.
//-
//- ****************************************************************************
 
#ifndef CrustalProfile_H
#define CrustalProfile_H
 
// **** _SYSTEM INCLUDES_ ******************************************************
 
#include <vector>
#include <set>
 
using namespace std;
 
// **** _LOCAL INCLUDES_ *******************************************************
 
#include "SLBMGlobals.h"
#include "InterpolatedProfile.h"
#include "Location.h"
#include "GreatCircle.h"
#include "TauPSite.h"
//#include "Grid.h"
 
// **** _BEGIN SLBM NAMESPACE_ **************************************************
 
namespace slbm {
 
class GridProfile;
 
class SLBM_EXP_IMP CrustalProfile : public InterpolatedProfile
{
 
public:
 
    CrustalProfile();
 
    CrustalProfile(const CrustalProfile& CrustalProfile);
 
    virtual ~CrustalProfile();
 
    CrustalProfile& operator=(const CrustalProfile& other);
 
    bool operator==(const CrustalProfile& other);
 
    bool operator!=(const CrustalProfile& other) {return ! (*this == other);};
 
    void setup(Grid& grid, const int& phase,
        const double& lat, const double& lon, const double& depth);
 
    const Location& getLocation() const { return location; };
 
    double getEarthRadius() { return location.getEarthRadius(); };
 
    int  getNIntervals() { return NLAYERS; };
 
    void getData(vector<double>& depths, vector<double>& velocities);
 
    double getInterfaceRadius(const int& k) { return radius[k]; };
 
    void getDepths(double* depths);
 
    double* getVelocities() { return velocity; };
 
    double getDepth(const int& k);
 
    double getVelocity(const int& k) { return velocity[k]; };
 
    double getPCrit(GreatCircle* greatCircle);
 
    void   xtCrust(
                GreatCircle* greatCircle,
                const double& rayParameter,
                double &xTotal,
                double &zTotal,
                double &sTotal,
                double &tTotal);
 
    void   xtCrust(
                GreatCircle* greatCircle,
                const double& rayParameter,
                int layid[],
                double x[],
                double r[],
                double v[],
                double t[],
                int& npoints);
 
    const int* getLayid() { return layid; };
 
    int getNLayid() { return nlay; };
 
    int getTopLayid() { return topLayid; };
 
    string toString(GreatCircle* greatCircle, double rayParameter);
    string toString();
 
    size_t memSize();
 
  void      setTauPSite(taup::TauPSite* tps);
 
  taup::TauPSite* getTauPSite();
 
  static int getClassCount();
 
  bool isInCrust() { return inCrust; };
 
private:
 
    static int crustalProfileClassCount;
 
    Location location;
 
    bool inCrust;
 
    int phase;
 
    double radius[NLAYERS];
 
    double velocity[NLAYERS];
 
    int layid[NLAYERS];
 
    int nlay;
 
    int topLayid;
 
    int nMiddleCrust;
 
    double fudgeFactor;
 
    taup::TauPSite* cpTPS;
};
 
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
//  INLINE FUNCTIONS
//
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
inline void CrustalProfile::getData(vector<double>& depths,
            vector<double>& velocities)
{
    depths.clear();
    velocities.clear();
    double R = getEarthRadius();
    for (int i=0; i<getNIntervals(); i++)
    {
        depths.push_back(R - radius[i]);
        velocities.push_back(velocity[i]);
    }
}
 
inline double CrustalProfile::getDepth(const int& k)
{
    return getEarthRadius() - radius[k];
}
 
inline void CrustalProfile::getDepths(double* depths)
{
    double R = getEarthRadius();
    for (int i=0; i<getNIntervals(); i++)
        depths[i] = R - radius[i];
}
 
inline double CrustalProfile::getPCrit(GreatCircle* greatCircle)
{
    return radius[greatCircle->getHeadWaveInterface()]
        / velocity[greatCircle->getHeadWaveInterface()];
}
 
} // end slbm namespace
 
#endif // CrustalProfile.h