Lemma is an Electromagnetics API
選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。

LayeredEarthEMReader.h 2.9KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  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/27/2013 01:44:36 PM
  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 LAYEREDEARTHEMREADER_INC
  18. #define LAYEREDEARTHEMREADER_INC
  19. #include "LemmaObject.h"
  20. #include "ASCIIParser.h"
  21. #include "layeredearthem.h"
  22. namespace Lemma {
  23. /**
  24. \brief
  25. \details
  26. */
  27. class LayeredEarthEMReader : public LemmaObject {
  28. friend std::ostream &operator<<(std::ostream &stream,
  29. const LayeredEarthEMReader &ob);
  30. public:
  31. // ==================== LIFECYCLE =======================
  32. /**
  33. * @copybrief LemmaObject::New()
  34. * @copydetails LemmaObject::New()
  35. */
  36. static LayeredEarthEMReader* New();
  37. /**
  38. * @copybrief LemmaObject::Delete()
  39. * @copydetails LemmaObject::Delete()
  40. */
  41. void Delete();
  42. // ==================== OPERATORS =======================
  43. // ==================== OPERATIONS =======================
  44. /** Reads ASCII input file. The format is as follows
  45. @code
  46. 4 // Number of NON-AIR layers
  47. 200 10 // resistivity, thickness layer 1 [Ohm-m] [m]
  48. 20 10 // resistivity, thickness layer 2 [Ohm-m] [m]
  49. 1120 10 // resistivity, thickness layer 3 [Ohm-m] [m]
  50. 200 // resistivity of bottom layer [Ohm-m]
  51. @endcode
  52. * @param[in] name is the filename
  53. */
  54. void ReadASCIIInputFile( const std::string& name );
  55. // ==================== ACCESS =======================
  56. /** @return the pointer address of the LayeredEarthEM
  57. */
  58. LayeredEarthEM* GetLayeredEarth();
  59. // ==================== INQUIRY =======================
  60. protected:
  61. // ==================== LIFECYCLE =======================
  62. /** Default protected constructor, use New */
  63. LayeredEarthEMReader (const std::string& name);
  64. /** Default protected destructor, use Delete */
  65. ~LayeredEarthEMReader ();
  66. /**
  67. * @copybrief LemmaObject::Release()
  68. * @copydetails LemmaObject::Release()
  69. */
  70. void Release();
  71. private:
  72. // ==================== DATA MEMBERS =========================
  73. LayeredEarthEM* LayEarth;
  74. }; // ----- end of class LayeredEarthEMReader -----
  75. } // ----- end of Lemma name -----
  76. #endif // ----- #ifndef LAYEREDEARTHEMREADER_INC -----