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.

Grid.h 2.3KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. /* This file is part of Lemma, a geophysical modelling and inversion API */
  2. /* This Source Code Form is subject to the terms of the Mozilla Public
  3. * License, v. 2.0. If a copy of the MPL was not distributed with this
  4. * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
  5. /**
  6. @file
  7. @author Trevor Irons
  8. @date 10/25/2009
  9. @version $Id: grid.h 193 2014-11-10 23:51:41Z tirons $
  10. **/
  11. #ifndef __GRID_H
  12. #define __GRID_H
  13. #include "LemmaObject.h"
  14. namespace Lemma {
  15. // ===============================================================================
  16. // Class: Grid
  17. /// \ingroup LemmaCore
  18. /// \brief Abstract base class for grids.
  19. /// \details Grids define values in space, they may either be an integral part
  20. /// of models, or simply the output of a forward modelling procedure.
  21. // ===============================================================================
  22. class Grid : public LemmaObject {
  23. friend std::ostream &operator<<(std::ostream &stream,
  24. const Grid &ob);
  25. public:
  26. // ==================== LIFECYCLE ===================================
  27. YAML::Node Serialize() const;
  28. // ==================== OPERATORS ===================================
  29. // ==================== OPERATIONS ===================================
  30. // ==================== ACCESS ===================================
  31. // ==================== INQUIRY ===================================
  32. /** Returns the name of the underlying class, similiar to Python's type */
  33. virtual inline std::string GetName() const {
  34. return this->CName;
  35. }
  36. protected:
  37. // ==================== LIFECYCLE ===================================
  38. /** Protected DeDerializing constructor, use factory DeSerialize method on non abstract classes*/
  39. Grid (const YAML::Node& node);
  40. /// Default protected constructor.
  41. Grid ( );
  42. /// Default protected constructor.
  43. ~Grid ();
  44. // ==================== DATA MEMBERS ===================================
  45. private:
  46. /** ASCII string representation of the class name */
  47. static constexpr auto CName = "Grid";
  48. }; // ----- end of class Grid -----
  49. } // namespace Lemma
  50. #endif // __GRID_H