GeoStack.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 GeoStack_H
#define GeoStack_H
 
// **** _SYSTEM INCLUDES_ ******************************************************
 
#include <vector>
#include <set>
 
using namespace std;
 
// **** _LOCAL INCLUDES_ *******************************************************
 
#include "SLBMGlobals.h"
 
// **** _BEGIN SLBM NAMESPACE_ **************************************************
 
namespace slbm {
 
class SLBM_EXP_IMP GeoStack
{
 
public:
 
    GeoStack();
 
    GeoStack(const int& index, double* depths, double* pvelocities,
        double* svelocities, double* gradients);
 
    ~GeoStack();
 
    GeoStack(const GeoStack& GeoStack);
 
    GeoStack& operator=(const GeoStack& other);
 
    bool operator==(const GeoStack& other);
 
    bool operator!=(const GeoStack& other) {return ! (*this == other);};
 
    int getRefCount() { return refCount; };
 
    void incRefCount() { ++refCount; };
 
    void decRefCount() { --refCount; };
 
    void setRefCount(const int& count) { refCount = count; };
 
    int getIndex() { return index; };
 
    void setIndex(const int& idx) { index = idx; };
 
    void getData(double* depths,
        double* pvelocity, double* svelocity, double* gradient);
 
    void setData(double* depths, double* pvelocities, double* svelocities,  double* gradients);
 
    void setDepth(const vector<double>& z);
 
    void setVelocity(const int& waveType, const vector<double>& velocity);
 
    void setGradient(const vector<double>& gradient);
 
    double getDepth(const int& k) { return depth[k]; };
 
    double* getDepth() { return depth; };
 
    double getVelocity(const int& waveType, const int& k);
 
    double getMantleGradient(const int& waveType);
 
    void getVelocity(const int& waveType, double* velocity);
 
    void getMantleGradient(double* g) { g[0] = gradient[0]; g[1] = gradient[1]; };
 
    bool hasLowVelocityZone();
 
    string toString();
 
    static int getClassCount();
 
    bool thicknessTest();
 
protected:
 
    static int geoStackClassCount;
 
    int index;
 
    int refCount;
 
    double depth[NLAYERS];
 
    double pvelocity[NLAYERS];
    double svelocity[NLAYERS];
 
    double gradient[2];
 
};
 
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
//  INLINE FUNCTIONS
//
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
inline void GeoStack::getData(double* d, double* pv, double* sv, double* g)
{
    for (int i=0; i<NLAYERS; i++)
    {
        d[i] = depth[i];
        pv[i] = pvelocity[i];
        sv[i] = svelocity[i];
    }
    g[PWAVE] = gradient[PWAVE];
    g[SWAVE] = gradient[SWAVE];
}
 
inline void GeoStack::setData(double* depths, double* pvelocities,
                              double* svelocities,  double* gradients)
{
    for (int i=0; i<NLAYERS; i++)
    {
        depth[i] = depths[i];
        pvelocity[i] = pvelocities[i];
        svelocity[i] = svelocities[i];
    }
    gradient[PWAVE] = gradients[PWAVE];
    gradient[SWAVE] = gradients[SWAVE];
 
    thicknessTest();
}
 
inline double GeoStack::getVelocity(const int& waveType, const int& k)
{
    if (waveType == PWAVE)
        return pvelocity[k];
    return svelocity[k];
}
 
inline double GeoStack::getMantleGradient(const int& waveType)
{
    return gradient[waveType];
}
 
inline void GeoStack::getVelocity(const int& waveType, double* v)
{
    if (waveType == PWAVE)
        for (int k=0; k<NLAYERS; ++k)
            v[k] = pvelocity[k];
    else
        for (int k=0; k<NLAYERS; ++k)
            v[k] = svelocity[k];
}
 
inline void GeoStack::setDepth(const vector<double>& z)
{
    for (int i=0; i<NLAYERS; i++)
        depth[i] = z[i];
 
    thicknessTest();
}
 
inline void GeoStack::setVelocity(const int& waveType, const vector<double>& v)
{
    if (waveType == PWAVE)
        for (int i=0; i<NLAYERS; i++)
            pvelocity[i] = v[i];
    else if (waveType == SWAVE)
        for (int i=0; i<NLAYERS; i++)
            svelocity[i] = v[i];
}
 
inline void GeoStack::setGradient(const vector<double>& g)
{
    gradient[PWAVE] = g[PWAVE];
    gradient[SWAVE] = g[SWAVE];
}
 
} // end slbm namespace
 
#endif // GeoStack.h