Lemma is an Electromagnetics API
Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.

layeredearthem.h 11KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314
  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 06/24/2009
  9. @version 0.0
  10. **/
  11. #ifndef __LAYEREDEARTHEM_H
  12. #define __LAYEREDEARTHEM_H
  13. #include "layeredearth.h"
  14. #include <iomanip>
  15. namespace Lemma {
  16. // =======================================================================
  17. // Class: LayeredEarthEM
  18. /// \brief 1D layered earth. Attributes include all aspects of
  19. /// Cole-Cole model.
  20. /// \details Primarily used for EM calculations.
  21. // =======================================================================
  22. class LayeredEarthEM : public LayeredEarth {
  23. public:
  24. // ==================== FRIENDS ===========================
  25. /** Recursively streams information about this class */
  26. friend std::ostream &operator<<(std::ostream &stream,
  27. const LayeredEarthEM &ob);
  28. // ==================== LIFECYCLE ===========================
  29. /**
  30. * Public constructor. Creates a new instance of the class and
  31. * assigns a reference to the thrown pointer.
  32. */
  33. static LayeredEarthEM* New();
  34. /**
  35. * @copybrief LemmaObject::Delete()
  36. * @copydetails LemmaObject::Delete()
  37. */
  38. void Delete();
  39. #ifdef HAVE_YAMLCPP
  40. /** YAML Serializing method
  41. */
  42. YAML::Node Serialize() const;
  43. //static LayeredEarthEM* DeSerialize(const YAML::Node& node);
  44. #endif
  45. /** @return a deep copy
  46. */
  47. LayeredEarthEM* Clone();
  48. // ==================== OPERATORS ===========================
  49. // ==================== OPERATIONS ===========================
  50. /** Evaluates the cole-cole model for suceptability and
  51. * permeability.
  52. * @param[in] omega is the frequency in Hz
  53. */
  54. void EvaluateColeColeModel(const Real& omega);
  55. // ==================== ACCESS ===========================
  56. /** Sets the number of layers and resizes all model parameters to
  57. * be the correct size, finally initialises all values to free
  58. * space.
  59. * @param[in] nlay is the number of layers
  60. */
  61. virtual void SetNumberOfLayers(const int& nlay);
  62. /** Sets Complex Conductivity of the layers
  63. * @param[in] sigma is a vector of the conducivity of the layers
  64. */
  65. void SetLayerConductivity(const VectorXcr &sigma);
  66. /** Sets Complex Conductivity of a single layer
  67. * @param[in] sigma is the conducivity of the layer
  68. * @param[in] ilay is the layer index
  69. */
  70. void SetLayerConductivity(const int& ilay, const Complex &sigma);
  71. /* Sets Complex resitivity of the layers
  72. * @param[in] ohm is a vector of the resistivity of the layers
  73. Singularity at 0 resistivity in air. Need to reformaulat things a bit
  74. */
  75. //void SetLayerResistivity(const VectorXcr &ohm);
  76. /** Sets the thickness of the layers
  77. * @param[in] thick is a vector of the thicknesses of the layers.
  78. * Must be two less than the total number of Layers as the top and
  79. * bottom layers are assumed infinite.
  80. */
  81. void SetLayerThickness(const VectorXr &thick);
  82. /** Sets the High frequency susceptibility
  83. */
  84. void SetLayerHighFreqSusceptibility(const VectorXr& sushi);
  85. /** Sets the Low frequency susceptibility
  86. */
  87. void SetLayerLowFreqSusceptibility(const VectorXr& sushi);
  88. /** Sets the Layer breath susceptibility
  89. */
  90. void SetLayerBreathSusceptibility(const VectorXr& susbr);
  91. /** Sets the Layer tau susceptibility
  92. */
  93. void SetLayerTauSusceptibility(const VectorXr& susta);
  94. /** Sets the High frequency permitivity
  95. */
  96. void SetLayerHighFreqPermitivity(const VectorXr& sushi);
  97. /** Sets the Low frequency permitivity
  98. */
  99. void SetLayerLowFreqPermitivity(const VectorXr& sushi);
  100. /** Sets the Layer breath permitivity
  101. */
  102. void SetLayerBreathPermitivity(const VectorXr& oerbr);
  103. /** Sets the Layer breath permitivity
  104. */
  105. void SetLayerTauPermitivity(const VectorXr& oerbr);
  106. // ==================== INQUIRY ===========================
  107. /** Returns the thickness of a layer
  108. @return a VectorXcr of the layer conductivities.
  109. */
  110. VectorXcr GetLayerConductivity( );
  111. /** Returns the conductivity of a layer
  112. * @param[in] ilay is the layer indice of interest
  113. * @return the complex valued conductivity of the layer of
  114. * interest.
  115. */
  116. Complex GetLayerConductivity(const int &ilay);
  117. /** Returns the susceptibility of a layer
  118. * @param[in] ilay is the layer indice of interest.
  119. * @return a Complex value of the electrical susceptibility of the
  120. * probes layer.
  121. */
  122. Complex GetLayerSusceptibility(const int &ilay);
  123. /** Returns the Susceptibility of Cole-Cole model
  124. * @return a VectorXcr of the suceptibilities of the model.
  125. */
  126. VectorXcr GetLayerSusceptibility( );
  127. /** Returns the low freq susceptibility of a layer
  128. */
  129. Real GetLayerLowFreqSusceptibility(const int &ilay);
  130. /** Returns the low freq susceptibility of a layer
  131. */
  132. VectorXr GetLayerLowFreqSusceptibility( );
  133. /** Returns the low freq susceptibility of a layer
  134. */
  135. Real GetLayerHighFreqSusceptibility(const int &ilay);
  136. /** Returns the low freq susceptibility of a layer
  137. */
  138. VectorXr GetLayerHighFreqSusceptibility( );
  139. /** Returns the low freq susceptibility of a layer
  140. */
  141. Real GetLayerTauSusceptibility(const int &ilay);
  142. /** Returns the low freq susceptibility of a layer
  143. */
  144. VectorXr GetLayerTauSusceptibility( );
  145. /** Returns the low freq susceptibility of a layer
  146. */
  147. Real GetLayerBreathSusceptibility(const int &ilay);
  148. /** Returns the low freq susceptibility of a layer
  149. */
  150. VectorXr GetLayerBreathSusceptibility( );
  151. /** Returns the Relative Permitivity of the cole cole model
  152. */
  153. VectorXcr GetLayerPermitivity( );
  154. /** Returns the conductivity of a layer
  155. * @param[in] ilay is the layer indice of interest.
  156. * @return a Complex value of the electrical permitivity of the
  157. * probed layer.
  158. */
  159. Complex GetLayerPermitivity(const int &ilay);
  160. /** Low Freq permivitity
  161. */
  162. VectorXr GetLayerLowFreqPermitivity( );
  163. /** Returns the low freq susceptibility of a layer
  164. */
  165. Real GetLayerLowFreqPermitivity(const int &ilay);
  166. /** Returns the low freq susceptibility of a layer
  167. */
  168. Real GetLayerHighFreqPermitivity(const int &ilay);
  169. /** Returns the low freq susceptibility of a layer
  170. */
  171. VectorXr GetLayerHighFreqPermitivity( );
  172. /** Returns the low freq susceptibility of a layer
  173. */
  174. Real GetLayerTauPermitivity(const int &ilay);
  175. /** Returns the low freq susceptibility of a layer
  176. */
  177. VectorXr GetLayerTauPermitivity( );
  178. /** Returns the low freq susceptibility of a layer
  179. */
  180. Real GetLayerBreathPermitivity(const int &ilay);
  181. /** Returns the low freq susceptibility of a layer
  182. */
  183. VectorXr GetLayerBreathPermitivity( );
  184. protected:
  185. // ==================== LIFECYCLE ===========================
  186. /** Default protected constructor. */
  187. LayeredEarthEM (const std::string &name);
  188. #ifdef HAVE_YAMLCPP
  189. /** Default protected constructor. */
  190. LayeredEarthEM (const YAML::Node& node);
  191. #endif
  192. /** Default protected constructor. */
  193. ~LayeredEarthEM ();
  194. /**
  195. * @copybrief LemmaObject::Release()
  196. * @copydetails LemmaObject::Release()
  197. */
  198. void Release();
  199. // ==================== DATA MEMBERS ===========================
  200. /** Vector of layer Conductivity */
  201. VectorXcr LayerConductivity;
  202. /** Vector of layer Susceptibility (chi)
  203. * This is calculated using the Cole-Cole model
  204. * \f[ sus(i) = sush(i)
  205. * + \frac{(susl(i)-sush(i))} {(1+(jw * sustau(i))^{susalp(i)})} \f]
  206. */
  207. VectorXcr LayerSusceptibility;
  208. /** Vector of low frequency susceptibility, for use in Cole-Cole
  209. model */
  210. VectorXr LayerLowFreqSusceptibility;
  211. /** Vector of high frequency susceptibility, for use in Cole-Cole
  212. model */
  213. VectorXr LayerHighFreqSusceptibility;
  214. /** Vector of relaxation time constants, for use in Cole-Cole model
  215. */
  216. VectorXr LayerTauSusceptibility;
  217. /** Vector relaxation breath, for use in Cole-Cole model
  218. */
  219. VectorXr LayerBreathSusceptibility;
  220. /** Vector of Layer Permitivity (epsilon)
  221. * Calculated using the Cole-Cole model
  222. * \f[ epr(i) = eprh(i)
  223. * + \frac{ (eprl(i)-eprh(i))} { (1+(jw*eprtau(i))^{epralp(i)})} \f]
  224. */
  225. VectorXcr LayerPermitivity;
  226. /** Low frequency permitivity for each layer */
  227. VectorXr LayerLowFreqPermitivity;
  228. /** High frequency permitivity for each layer */
  229. VectorXr LayerHighFreqPermitivity;
  230. /** Decay time constant for each layer */
  231. VectorXr LayerTauPermitivity;
  232. /** Relaxation breath for each layer */
  233. VectorXr LayerBreathPermitivity;
  234. }; // ----- end of class LayeredEarthEM -----
  235. } // namespace Lemma
  236. #endif // __LAYEREDEARTHEM_H