Surface NMR forward modelling
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

LayeredEarthMR.h 5.4KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  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 08/28/2017 03:32:26 PM
  11. * @version $Id$
  12. * @author Trevor Irons (ti)
  13. * @email tirons@egi.utah.edu
  14. * @copyright Copyright (c) 2017, University of Utah
  15. * @copyright Copyright (c) 2017, Lemma Software, LLC
  16. */
  17. #ifndef LAYEREDEARTHMR_INC
  18. #define LAYEREDEARTHMR_INC
  19. #pragma once
  20. #include "LayeredEarth.h"
  21. #include "MerlinConfig.h"
  22. #include "KernelV0.h"
  23. namespace Lemma {
  24. /**
  25. * \ingroup Merlin
  26. * \brief
  27. * \details
  28. */
  29. class LayeredEarthMR : public LayeredEarth {
  30. friend std::ostream &operator<<(std::ostream &stream, const LayeredEarthMR &ob);
  31. protected:
  32. /*
  33. * This key is used to lock the constructor. It is protected so that inhereted
  34. * classes also have the key to contruct their base class.
  35. */
  36. struct ctor_key {};
  37. public:
  38. // ==================== LIFECYCLE =======================
  39. /**
  40. * Default constructor.
  41. * @note This method is locked, and cannot be called directly.
  42. * The reason that the method is public is to enable the use
  43. * of make_shared whilst enforcing the use of shared_ptr,
  44. * in c++-17, this curiosity may be resolved.
  45. * @see LayeredEarthMR::NewSP
  46. */
  47. explicit LayeredEarthMR ( const ctor_key& );
  48. /**
  49. * DeSerializing constructor.
  50. * @note This method is locked, and cannot be called directly.
  51. * The reason that the method is public is to enable the use
  52. * of make_shared whilst enforcing the use of shared_ptr,
  53. * in c++-17, this curiosity may be resolved.
  54. * @see LayeredEarthMR::DeSerialize
  55. */
  56. LayeredEarthMR ( const YAML::Node& node, const ctor_key& );
  57. /**
  58. * Default destructor.
  59. * @note This method should never be called due to the mandated
  60. * use of smart pointers. It is necessary to keep the method
  61. * public in order to allow for the use of the more efficient
  62. * make_shared constructor.
  63. */
  64. virtual ~LayeredEarthMR ();
  65. /**
  66. * Uses YAML to serialize this object.
  67. * @return a YAML::Node
  68. * @see LayeredEarthMR::DeSerialize
  69. */
  70. virtual YAML::Node Serialize() const;
  71. /**
  72. * Factory method for generating concrete class.
  73. * @return a std::shared_ptr of type LayeredEarthMR
  74. */
  75. static std::shared_ptr< LayeredEarthMR > NewSP();
  76. /**
  77. * Constructs an LayeredEarthMR object from a YAML::Node.
  78. * @see LayeredEarthMR::Serialize
  79. */
  80. static std::shared_ptr<LayeredEarthMR> DeSerialize(const YAML::Node& node);
  81. // ==================== OPERATORS =======================
  82. // ==================== OPERATIONS =======================
  83. // ==================== ACCESS =======================
  84. /**
  85. * @return a VectorXr of the T2* bins
  86. */
  87. VectorXr GetT2StarBins();
  88. /**
  89. * @return a flattened version of the model matrix
  90. */
  91. VectorXr GetModelVector();
  92. /**
  93. * @return the model matrix
  94. */
  95. MatrixXr GetModelMatrix();
  96. /**
  97. * Sets the T2StarBins to solve for, these are log spaced
  98. * @param[in] first is the beginning of the bins
  99. * @param[in] last is the end of the bins
  100. * @param[in] nT2 is the number of bins
  101. */
  102. void SetT2StarBins(const Real& first, const Real& last, const int& nT2);
  103. /**
  104. * Convenience method, that aligns model with a Kernel
  105. * @param[in] Kern input kernel to align with
  106. */
  107. void AlignWithKernel( std::shared_ptr<KernelV0> Kern );
  108. // ==================== INQUIRY =======================
  109. /**
  110. * Returns the name of the underlying class, similiar to Python's type
  111. * @return string of class name
  112. */
  113. virtual inline std::string GetName() const {
  114. return CName;
  115. }
  116. protected:
  117. // ==================== LIFECYCLE =======================
  118. /** Copy is disabled */
  119. LayeredEarthMR( const LayeredEarthMR& ) = delete;
  120. // ==================== DATA MEMBERS =========================
  121. private:
  122. /** ASCII string representation of the class name */
  123. static constexpr auto CName = "LayeredEarthMR";
  124. /**
  125. * Sets the number of layers
  126. */
  127. void SetNumberOfLayers(const int& nlay);
  128. /** Initializes the model matrix */
  129. void InitModelMat();
  130. VectorXr Interfaces; // Layer interfaces, for pcolor
  131. VectorXr T2StarBins; // the actual T2* values
  132. VectorXr T2StarBinEdges; // Convenience, for pcolor
  133. MatrixXr ModelMat; // The NMR model, in matrix form
  134. }; // ----- end of class LayeredEarthMR -----
  135. } // ----- end of namespace Lemma ----
  136. /* vim: set tabstop=4 expandtab: */
  137. /* vim: set filetype=cpp: */
  138. #endif // ----- #ifndef LAYEREDEARTHMR_INC -----