Lemma is an Electromagnetics API
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

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