GridProfileSLBM.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 GRIDPROFILESLBM_H_
#define GRIDPROFILESLBM_H_
 
// **** _SYSTEM INCLUDES_ ******************************************************
 
#include <vector>
#include <set>
 
using namespace std;
 
// **** _LOCAL INCLUDES_ *******************************************************
 
#include "SLBMGlobals.h"
#include "Location.h"
#include "GeoStack.h"
 
// **** _BEGIN SLBM NAMESPACE_ **************************************************
 
namespace slbm {
 
class InterpolatedProfile;
class Grid;
 
class SLBM_EXP_IMP GridProfileSLBM : public GridProfile
{
 
// let Grid objects access protected members of GridProfileSLBM.
friend class Grid;
 
public:
 
    GridProfileSLBM(Grid& g,
             const int& i, const double& lat,
             const double& lon, const double& elev,
             const double& zwater, GeoStack* gstack);
 
    GridProfileSLBM(const GridProfileSLBM &other);
 
    ~GridProfileSLBM();
 
    static string class_name() { return "GridProfileSLBM"; };
 
    int getGeoStackId() { return geoStack->getIndex(); };
 
    void getData(double* depths, double* pvelocity, double* svelocity, double* gradient);
 
    void setData(double* depths, double* pvelocities,
        double* svelocities,    double* gradients);
 
    void setDepths(const vector<double>& depths);
 
    void setVelocity(const int& waveType, const vector<double>& velocity);
 
    void setGradient(const vector<double>& gradient);
 
    double getInterfaceRadius(const int& k);
 
    double getInterfaceDepth(const int& k);
 
    double getVelocity(const int& waveType, const int& k)
    { return geoStack->getVelocity(waveType, k); };
 
    double getMantleGradient(const int& waveType)
    { return geoStack->getMantleGradient(waveType); };
 
    void getInterfaceDepths(vector<double>& depths);
 
    void getVelocity(const int& waveType, double* velocity)
    { geoStack->getVelocity(waveType, velocity); };
 
    void getMantleGradient(double* g) { geoStack->getMantleGradient(g); };
 
    double getWaterThick() { return waterThick; };
 
protected:
 
    Grid& grid;
 
    GeoStack* geoStack;
 
    double waterThick;
 
};
 
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
//  INLINE FUNCTIONS
//
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
inline double GridProfileSLBM::getInterfaceRadius(const int& k)
{
    // radius is the radius of the surface of the solid earth.
    // geoStack->getDepth(k) returns the depth of top of layer k
    // relative to surface of solid earth.
    // The difference is the radius of the top of layer k.
    // Layer 0 is the water layer and waterThick is the nominal
    // thickness of the water layer.  Since waterThick is only
    // a nominal value, it is not guaranteed that top of water
    // is at sea level.
    if (k > 0)
        return radius - geoStack->getDepth(k);
    return radius + waterThick;
}
 
inline void GridProfileSLBM::getData(double* d,
            double* pv, double* sv, double* g)
{
    double r = getEarthRadius();
    for (int k=0; k<NLAYERS; k++)
    {
        d[k]  = r - getInterfaceRadius(k);
        pv[k] = geoStack->getVelocity(PWAVE, k);
        sv[k] = geoStack->getVelocity(SWAVE, k);
    }
    g[PWAVE] = geoStack->getMantleGradient(PWAVE);
    g[SWAVE] = geoStack->getMantleGradient(SWAVE);
}
 
inline double GridProfileSLBM::getInterfaceDepth(const int& k)
{
    // getEarthRadius is the radius of sea level.
    return getEarthRadius() - getInterfaceRadius(k);
}
 
inline void GridProfileSLBM::getInterfaceDepths(vector<double>& depths)
{
    depths.resize(NLAYERS);
    double r = getEarthRadius();
    for (int k=0; k<NLAYERS; k++)
        depths[k] = r - getInterfaceRadius(k);
}
 
} // end slbm namespace
 
#endif // GRIDPROFILESLBM_H_.h