Lemma is an Electromagnetics API
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.

UngroundedElectricDipole.h 2.4KB

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 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. \ingroup FDEM1D
  23. \brief Ungrounded electric dipole
  24. \details Used to model an idealised ungrounded electric dipole. Used primarily in integrating
  25. around current sources.
  26. */
  27. class UngroundedElectricDipole : public DipoleSource {
  28. friend std::ostream &operator<<(std::ostream &stream,
  29. const UngroundedElectricDipole &ob);
  30. public:
  31. // ==================== LIFECYCLE =======================
  32. /**
  33. * @copybrief LemmaObject::New()
  34. * @copydetails LemmaObject::New()
  35. */
  36. static UngroundedElectricDipole* 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. UngroundedElectricDipole (const std::string& name);
  50. /** Default protected destructor, use Delete */
  51. ~UngroundedElectricDipole ();
  52. /**
  53. * @copybrief LemmaObject::Release()
  54. * @copydetails LemmaObject::Release()
  55. */
  56. void Release();
  57. private:
  58. // ==================== DATA MEMBERS =========================
  59. }; // ----- end of class UngroundedElectricDipole -----
  60. } // ----- end of Lemma name -----
  61. #endif // ----- #ifndef UNGROUNDEDELECTRICDIPOLE_INC -----