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.

kernelem1dbase.h 2.9KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  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 05/18/2012
  9. @version $Id: kernelem1dbase.h 193 2014-11-10 23:51:41Z tirons $
  10. **/
  11. #ifndef KERNELEM1DBASE_INC
  12. #define KERNELEM1DBASE_INC
  13. #include "LemmaObject.h"
  14. namespace Lemma {
  15. // Transverse electric or magnetic mode
  16. enum EMMODE {TM, TE, NONE};
  17. // ===================================================================
  18. // Class: KernelEm1DBase
  19. /**
  20. @class
  21. \brief Pure virtual base class of KernelEm1D
  22. \details Defines interface for HankelTransform classes
  23. */
  24. // ===================================================================
  25. class KernelEm1DBase : public LemmaObject {
  26. friend class KernelEM1DManager;
  27. public:
  28. // ==================== LIFECYCLE =======================
  29. /// Default protected constructor.
  30. KernelEm1DBase ( ) : LemmaObject( ) {
  31. }
  32. /// Default protected constructor.
  33. ~KernelEm1DBase () {
  34. }
  35. // ==================== OPERATORS =======================
  36. // ==================== OPERATIONS =======================
  37. /** Returns the Complex bessel argument to be evaluated for a given
  38. * lambda value
  39. */
  40. virtual Complex BesselArg(const Real& lambda)=0;
  41. /** Returns the complex bessel argument. Same as above, but does not
  42. * call reflection coefficient calculation in KernelEM1DReflBase.
  43. * @param[in] lambda is the hankel wave value.
  44. */
  45. virtual Complex RelBesselArg(const Real& lambda)=0;
  46. // ==================== ACCESS =======================
  47. virtual void SetIk(const int& ik)=0;
  48. virtual void SetMode(const EMMODE& mode)=0;
  49. int GetManagerIndex() {
  50. return this->managerIdx;
  51. }
  52. // ==================== INQUIRY =======================
  53. virtual int GetNumRel()=0;
  54. virtual int GetBesselOrder()=0;
  55. virtual Complex GetZm()=0;
  56. virtual Complex GetYm()=0;
  57. virtual Complex GetZs()=0;
  58. virtual Complex GetKs()=0;
  59. protected:
  60. // ==================== DATA MEMBERS =========================
  61. /** Where does this kernel live on the vector managed by the manager */
  62. int managerIdx;
  63. private:
  64. /** ASCII string representation of the class name */
  65. static constexpr auto CName = "KernelEM1DBase";
  66. }; // ----- end of class KernelEm1DBase -----
  67. } // namespace Lemma
  68. #endif // ----- #ifndef KERNELEM1DBASE_INC -----