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.

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. /* This file is part of Lemma, a geophysical modelling and inversion API.
  2. * More information is available at http://lemmasoftware.org
  3. */
  4. /* This Source Code Form is subject to the terms of the Mozilla Public
  5. * License, v. 2.0. If a copy of the MPL was not distributed with this
  6. * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  7. */
  8. /**
  9. * @file
  10. * @date 09/25/2013 08:20:14 AM
  11. * @version $Id$
  12. * @author Trevor Irons (ti)
  13. * @email Trevor.Irons@xri-geo.com
  14. * @copyright Copyright (c) 2013, XRI Geophysics, LLC
  15. * @copyright Copyright (c) 2013, Trevor Irons
  16. */
  17. #ifndef MAGNETICDIPOLE_INC
  18. #define MAGNETICDIPOLE_INC
  19. #include "dipolesource.h"
  20. namespace Lemma {
  21. /**
  22. @class
  23. \ingroup FDEM1D
  24. \brief Magnetic Dipole
  25. \details Used to model an idealised magnetic dipole of arbitrary
  26. polarisation.
  27. */
  28. class MagneticDipole : public DipoleSource {
  29. friend std::ostream &operator<<(std::ostream &stream,
  30. const MagneticDipole &ob);
  31. public:
  32. // ==================== LIFECYCLE =======================
  33. /**
  34. * @copybrief LemmaObject::New()
  35. * @copydetails LemmaObject::New()
  36. */
  37. static MagneticDipole* New();
  38. /**
  39. * @copybrief LemmaObject::Delete()
  40. * @copydetails LemmaObject::Delete()
  41. */
  42. void Delete();
  43. // ==================== OPERATORS =======================
  44. // ==================== OPERATIONS =======================
  45. // ==================== ACCESS =======================
  46. // ==================== INQUIRY =======================
  47. protected:
  48. // ==================== LIFECYCLE =======================
  49. /** Default protected constructor, use New */
  50. MagneticDipole (const std::string& name);
  51. /** Default protected destructor, use Delete */
  52. ~MagneticDipole ();
  53. /**
  54. * @copybrief LemmaObject::Release()
  55. * @copydetails LemmaObject::Release()
  56. */
  57. void Release();
  58. private:
  59. // ==================== DATA MEMBERS =========================
  60. KernelEM1DManager* Kernels;
  61. }; // ----- end of class MagneticDipole -----
  62. } // namespace Lemma
  63. #endif // ----- #ifndef MAGNETICDIPOLE_INC -----