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.

GroundedElectricDipole.h 2.4KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  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 01/29/2014 06:59:39 AM
  11. * @version $Id$
  12. * @author Trevor Irons (ti)
  13. * @email Trevor.Irons@xri-geo.com
  14. * @copyright Copyright (c) 2014, XRI Geophysics, LLC
  15. * @copyright Copyright (c) 2014, Trevor Irons
  16. */
  17. #ifndef GROUNDEDELECTRICDIPOLE_INC
  18. #define GROUNDEDELECTRICDIPOLE_INC
  19. #include "dipolesource.h"
  20. namespace Lemma {
  21. /**
  22. \ingroup FDEM1D
  23. \brief Grounded electric dipole
  24. \details Used to model an idealised grounded electrid dipole of arbitrary
  25. polarisation.
  26. */
  27. class GroundedElectricDipole : public DipoleSource {
  28. friend std::ostream &operator<<(std::ostream &stream,
  29. const GroundedElectricDipole &ob);
  30. public:
  31. // ==================== LIFECYCLE =======================
  32. /**
  33. * @copybrief LemmaObject::New()
  34. * @copydetails LemmaObject::New()
  35. */
  36. static GroundedElectricDipole* New();
  37. /**
  38. * @copybrief LemmaObject::Delete()
  39. * @copydetails LemmaObject::Delete()
  40. */
  41. void Delete();
  42. // ==================== OPERATORS =======================
  43. // ==================== OPERATIONS =======================
  44. // ==================== ACCESS =======================
  45. // ==================== INQUIRY =======================
  46. protected:
  47. // ==================== LIFECYCLE =======================
  48. /** Default protected constructor, use New */
  49. GroundedElectricDipole (const std::string& name);
  50. /** Default protected destructor, use Delete */
  51. ~GroundedElectricDipole ();
  52. /**
  53. * @copybrief LemmaObject::Release()
  54. * @copydetails LemmaObject::Release()
  55. */
  56. void Release();
  57. private:
  58. // ==================== DATA MEMBERS =========================
  59. }; // ----- end of class GroundedElectricDipole -----
  60. } // ----- end of Lemma name -----
  61. #endif // ----- #ifndef GROUNDEDELECTRICDIPOLE_INC -----