RSTT  3.2.0
Regional Seismic Travel Time
All Classes Namespaces Files Functions Variables Typedefs Friends Macros
GreatCircle_Xg.h
Go to the documentation of this file.
1 //- ****************************************************************************
2 //-
3 //- Copyright 2009 National Technology & Engineering Solutions of Sandia, LLC
4 //- (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
5 //- Government retains certain rights in this software.
6 //-
7 //- BSD Open Source License
8 //- All rights reserved.
9 //-
10 //- Redistribution and use in source and binary forms, with or without
11 //- modification, are permitted provided that the following conditions are met:
12 //-
13 //- 1. Redistributions of source code must retain the above copyright notice,
14 //- this list of conditions and the following disclaimer.
15 //-
16 //- 2. Redistributions in binary form must reproduce the above copyright
17 //- notice, this list of conditions and the following disclaimer in the
18 //- documentation and/or other materials provided with the distribution.
19 //-
20 //- 3. Neither the name of the copyright holder nor the names of its
21 //- contributors may be used to endorse or promote products derived from
22 //- this software without specific prior written permission.
23 //-
24 //- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 //- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 //- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 //- ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
28 //- LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 //- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 //- SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 //- INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 //- CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 //- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 //- POSSIBILITY OF SUCH DAMAGE.
35 //-
36 //- ****************************************************************************
37 
38 #ifndef GreatCircle_Xg_H
39 #define GreatCircle_Xg_H
40 
41 // **** _SYSTEM INCLUDES_ ******************************************************
42 
43 #include <vector>
44 #include <string>
45 #include <iostream>
46 
47 // **** _LOCAL INCLUDES_ *******************************************************
48 
49 #include "SLBMGlobals.h"
50 #include "GreatCircle.h"
51 #include "Grid.h"
52 #include "Location.h"
53 #include "CrustalProfile.h"
54 #include "LayerProfile.h"
55 #include "TauPSite.h"
56 
57 using namespace std;
58 
59 // **** _BEGIN SLBM NAMESPACE_ **************************************************
60 
61 namespace slbm {
62 
63 // **** _CLASS DEFINITION_ *****************************************************
78 {
79 
80 public:
81 
95  const int& _phase,
96  Grid& _grid,
97  const double& latSource,
98  const double& lonSource,
99  const double& depthSource,
100  const double& latReceiver,
101  const double& lonReceiver,
102  const double& depthReceiver);
103 
112 
117 
122 
129 
130  void getZhaoParameters(double& Vm, double& Gm, double& H, double& C, double& Cm, int& udSign);
131 
132  void getPgLgComponents(double& tTotal,
133  double& tTaup, double& tHeadwave,
134  double& pTaup, double& pHeadwave,
135  double& trTaup, double& trHeadwave);
136 
155  string toString(const int& verbosity);
156 
157 private:
158 
163  double pSource;
164 
169  double pReceiver;
170 
172  double tHeadwave;
173 
175  //double tTaup;
176 
178  double pHeadwave;
179 
181  double pTaup;
182 
184  double trHeadwave;
185 
187  //double trTaup;
188 
189  double taupModelRadius;
190 
191  taup::TravelTimeResult* taupResult;
192 
193  void computeTravelTimeTaup();
194 
195  void computeTravelTimeHeadwave();
196 
197  //void computeTravelTimeHeadwave2();
198 
199  void toStringTaup(ostringstream&, const int& verbosity);
200 
201  void toStringHeadwave(ostringstream&, const int& verbosity);
202 
203 };
204 
205 inline void GreatCircle_Xg::getZhaoParameters(double& Vm_, double& Gm_, double& H_, double& C_, double& Cm_, int& udSign_)
206 {
207  Vm_ = NA_VALUE;
208  Gm_ = NA_VALUE;
209  H_ = NA_VALUE;
210  C_ = NA_VALUE;
211  Cm_ = NA_VALUE;
212  udSign_ = -999;
213 }
214 
215 inline void GreatCircle_Xg::getPgLgComponents(double& tT, double& tP, double& tH,
216  double& pT, double& pH, double& trT, double& trH)
217 {
218  tT = tTotal;
219  tP = (taupResult ? taupResult->ttrT : NA_VALUE);
220  tH = tHeadwave;
221  pT = (taupResult ? taupResult->ttrP / taupResult->ttrR : NA_VALUE);
222  pH = pHeadwave;
223  trT = (taupResult ? taupResult->ttrR : NA_VALUE);
224  trH = trHeadwave;
225 }
226 
227 } // end slbm namespace
228 
229 #endif // GreatCircle_Xg.h
#define SLBM_EXP
Definition: SLBMGlobals.h:181
The GreatCircle_Xg class manages information related to a great circle path between two Locations on ...
string toString(const int &verbosity)
Retrieve a formatted string providing a detailed description of the information managed by this Great...
GreatCircle_Xg(const int &_phase, Grid &_grid, const double &latSource, const double &lonSource, const double &depthSource, const double &latReceiver, const double &lonReceiver, const double &depthReceiver)
Parameterized constructor.
GreatCircle_Xg(const GreatCircle_Xg &other)
Copy constructor.
GreatCircle_Xg & operator=(const GreatCircle_Xg &other)
Equal operator.
~GreatCircle_Xg()
Destructor. Calls GreatCircle destructor, which deletes the source and receiver CrustalProfile object...
The GreatCircle class manages information related to a great circle path between two Locations on the...
Definition: GreatCircle.h:114
A 2 dimensional, horizontal grid of GirdProfile objects.
Definition: Grid.h:91
A public container (struct) that holds the result of a specific ray that satisfied the source distanc...
Definition: TauPSite.h:844