Lemma is an Electromagnetics API
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

EMEarth1D.h 8.3KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263
  1. /* This file is part of Lemma, a geophysical modelling and inversion API */
  2. /* This Source Code Form is subject to the terms of the Mozilla Public
  3. * License, v. 2.0. If a copy of the MPL was not distributed with this
  4. * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
  5. /**
  6. @file
  7. @author Trevor Irons
  8. @date 12/02/2009
  9. **/
  10. #ifndef __EMEARTH1D_H
  11. #define __EMEARTH1D_H
  12. // forward declare these due to include cycle
  13. //#include "LayeredEarthEM.h"
  14. //#include "DipoleSource.h"
  15. //#include "FieldPoints.h"
  16. //#include "WireAntenna.h"
  17. //#include "PolygonalWireAntenna.h"
  18. //#include "KernelEM1DManager.h"
  19. #include "KernelEM1DSpec.h"
  20. #include "GQChave.h"
  21. #include "FHTAnderson801.h"
  22. #include "FHTKey201.h"
  23. #include "FHTKey101.h"
  24. #include "FHTKey51.h"
  25. #include "QWEKey.h"
  26. #include "CubicSplineInterpolator.h"
  27. #ifdef HAVEBOOSTPROGRESS
  28. #include "boost/progress.hpp"
  29. #endif
  30. namespace Lemma {
  31. enum TXRXMODE { TX, RX, TXRX, NOMODE };
  32. class WireAntenna;
  33. class PolygonalWireAntenna;
  34. class FieldPoints;
  35. class DipoleSource;
  36. class LayeredEarthEM;
  37. // =======================================================================
  38. // Class: EmEarth1D
  39. /// \brief Implimentation of 1D EM solution.
  40. /// \details We've done a lot of different things.
  41. // =======================================================================
  42. class EMEarth1D : public LemmaObject {
  43. friend std::ostream &operator<<(std::ostream &stream,
  44. const EMEarth1D &ob);
  45. struct ctor_key{};
  46. public:
  47. //friend class KernelEm1D;
  48. // ==================== LIFECYCLE ===========================
  49. /** Default protected constructor. */
  50. explicit EMEarth1D ( const ctor_key& );
  51. /** Default protected constructor. */
  52. EMEarth1D ( const YAML::Node& node, const ctor_key& );
  53. /** Default protected constructor. */
  54. ~EMEarth1D ();
  55. /**
  56. * Returns pointer to new EMEarth1D. Location is
  57. * initialized to (0,0,0) type and polarization are
  58. * initialized to nonworking values that will throw
  59. * exceptions if used.
  60. */
  61. static std::shared_ptr<EMEarth1D> NewSP();
  62. /** stream debugging info to std::out
  63. */
  64. void Query();
  65. /** YAML Serializing method
  66. */
  67. YAML::Node Serialize() const;
  68. //static EMEarth1D* DeSerialize(const YAML::Node& node);
  69. // ==================== OPERATORS ===========================
  70. // ==================== OPERATIONS ===========================
  71. /// Calculates the field(s) due to an ungrounded dipole source
  72. /// Calls FORTRAN library em1d (em1dnew.for)
  73. #ifdef KIHALEE_EM1D
  74. void MakeCalc();
  75. #endif
  76. /** C++ wrapper for em1dnew.for, serial */
  77. void MakeCalc3();
  78. /** Calculates the field(s) due to a wire antennae */
  79. void CalculateWireAntennaFields(bool progressbar=false);
  80. // ==================== ACCESS ===========================
  81. /** Attaches an antennae */
  82. void AttachWireAntenna( std::shared_ptr<WireAntenna> antennae);
  83. /** Attaches a dipole for calculation */
  84. void AttachDipoleSource( std::shared_ptr<DipoleSource> dipole);
  85. /** Attaches a layered earth model for calculation */
  86. void AttachLayeredEarthEM( std::shared_ptr<LayeredEarthEM> Earth);
  87. /** Attaches a set of receiver points for calculation */
  88. void AttachFieldPoints( std::shared_ptr<FieldPoints> Receivers);
  89. /** Sets the fields that are calcultated, E,H or BOTH */
  90. void SetFieldsToCalculate(const FIELDCALCULATIONS &calc);
  91. /** Sets the method to use to evaluate the Hankel integral,
  92. */
  93. void SetHankelTransformMethod(const HANKELTRANSFORMTYPE &type);
  94. /**
  95. * Accesor for field points
  96. */
  97. inline FieldPoints* GetFieldPoints() {
  98. return this->Receivers.get();
  99. }
  100. /**
  101. * Sets the Mode enum tag.
  102. */
  103. void SetTxRxMode( const TXRXMODE& ModeSet ) {
  104. this->Mode = ModeSet;
  105. }
  106. // ==================== INQUIRY ===========================
  107. /**
  108. * Returns the name of the underlying class, similiar to Python's type
  109. * @return string of class name
  110. */
  111. virtual std::string GetName() const;
  112. /**
  113. * Returns the Mode enum tag.
  114. */
  115. inline TXRXMODE GetTxRxMode() const {
  116. return Mode;
  117. }
  118. protected:
  119. // ==================== OPERATIONS ===========================
  120. /** Used internally, this is the innermost loop of the MakeCalc3,
  121. * and CalculateWireAntennaField routines.
  122. */
  123. void SolveSingleTxRxPair(const int &irec,
  124. HankelTransform* Hankel,
  125. const Real &wavef, const int &ifreq,
  126. DipoleSource* tDipole);
  127. // void SolveSingleTxRxPair(const int &irec,
  128. // std::shared_ptr<HankelTransform> Hankel,
  129. // const Real &wavef, const int &ifreq,
  130. // std::shared_ptr<DipoleSource> tDipole);
  131. /** Used internally, this is the innermost loop of the MakeCalc3,
  132. * and CalculateWireAntennaField routines.
  133. */
  134. void SolveLaggedTxRxPair(const int &irec, FHTAnderson801* Hankel,
  135. const Real &wavef, const int &ifreq,
  136. PolygonalWireAntenna* antenna);
  137. // ==================== DATA MEMBERS ===========================
  138. /** Computes field due to dipole */
  139. std::shared_ptr<DipoleSource> Dipole;
  140. /** Earth model (Cole-cole) */
  141. std::shared_ptr<LayeredEarthEM> Earth;
  142. /** Receiver points */
  143. std::shared_ptr<FieldPoints> Receivers;
  144. /** Wire antennae tx */
  145. std::shared_ptr<WireAntenna> Antenna;
  146. /** What fields are wanted */
  147. FIELDCALCULATIONS FieldsToCalculate;
  148. /** The type of Hankel transform to use, default to digital
  149. * filtering
  150. */
  151. HANKELTRANSFORMTYPE HankelType;
  152. /** Counter for number of caclulations made
  153. */
  154. int icalcinner;
  155. /** Counter for number of caclulations made
  156. */
  157. int icalc;
  158. /**
  159. * Convenience tag that can be used for marking whether these
  160. * fields are part of a transmit or receive array.
  161. */
  162. TXRXMODE Mode = NOMODE;
  163. /** ASCII string representation of the class name */
  164. static constexpr auto CName = "EMEarth1D";
  165. }; // ----- end of class EMEarth1D -----
  166. /////////////////////////////////////////
  167. // Exception classes
  168. /** If a Receivers Class is NULL valued, throw this.
  169. */
  170. class NullReceivers : public std::runtime_error {
  171. /** Thrown when Receivers pointer is NULL
  172. */
  173. public: NullReceivers();
  174. };
  175. /** If an Antenna is NULL valued, throw this error.
  176. */
  177. class NullAntenna : public std::runtime_error {
  178. /** Thrown when an antenna pointer is NULL
  179. */
  180. public: NullAntenna();
  181. };
  182. /** If an Instrument is NULL valued, throw this error.
  183. */
  184. class NullInstrument : public std::runtime_error {
  185. /** thrown when an instrument pointer is NULL.
  186. * @param[in] ptr is a pointer to the class throwing the exception.
  187. */
  188. public: NullInstrument(LemmaObject* ptr);
  189. };
  190. /** If a dipole source is specified, but a method calling a wire antenna is
  191. * called, throw this.
  192. */
  193. class DipoleSourceSpecifiedForWireAntennaCalc : public std::runtime_error {
  194. /** Thrown when a dipole source is specified when a wire antenna is
  195. * expected
  196. */
  197. public: DipoleSourceSpecifiedForWireAntennaCalc();
  198. };
  199. } // Namespace Lemma
  200. #endif // __EMEARTH1D_H