Main Lemma Repository
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.

UngroundedElectricDipole.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 08:52:43 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 UNGROUNDEDELECTRICDIPOLE_INC
  18. #define UNGROUNDEDELECTRICDIPOLE_INC
  19. #include "dipolesource.h"
  20. namespace Lemma {
  21. /**
  22. \brief Ungrounded electric dipole
  23. \details Used to model an idealised ungrounded electric dipole. Used primarily in integrating
  24. around current sources.
  25. */
  26. class UngroundedElectricDipole : public DipoleSource {
  27. friend std::ostream &operator<<(std::ostream &stream,
  28. const UngroundedElectricDipole &ob);
  29. public:
  30. // ==================== LIFECYCLE =======================
  31. /**
  32. * @copybrief LemmaObject::New()
  33. * @copydetails LemmaObject::New()
  34. */
  35. static UngroundedElectricDipole* New();
  36. /**
  37. * @copybrief LemmaObject::Delete()
  38. * @copydetails LemmaObject::Delete()
  39. */
  40. void Delete();
  41. // ==================== OPERATORS =======================
  42. // ==================== OPERATIONS =======================
  43. // ==================== ACCESS =======================
  44. // ==================== INQUIRY =======================
  45. protected:
  46. // ==================== LIFECYCLE =======================
  47. /** Default protected constructor, use New */
  48. UngroundedElectricDipole (const std::string& name);
  49. /** Default protected destructor, use Delete */
  50. ~UngroundedElectricDipole ();
  51. /**
  52. * @copybrief LemmaObject::Release()
  53. * @copydetails LemmaObject::Release()
  54. */
  55. void Release();
  56. private:
  57. // ==================== DATA MEMBERS =========================
  58. }; // ----- end of class UngroundedElectricDipole -----
  59. } // ----- end of Lemma name -----
  60. #endif // ----- #ifndef UNGROUNDEDELECTRICDIPOLE_INC -----