Merge pull request #489 from lanl/jhp/nlambda

Author: Yurlungur

CHANGELOG.md

@@ -26,6 +26,7 @@
 ### Infrastructure (changes irrelevant to downstream codes)
 - [[PR481]](https://github.com/lanl/singularity-eos/pull/481) Move mutable diagnostic variables in singularity-eos into optional indexable types in a lambda.
 - [[PR486]](https://github.com/lanl/singularity-eos/pull/486) Use default behavior for max_scratch_size and scratch_size in the eos base class
+- [[PR489]](https://github.com/lanl/singularity-eos/pull/489) Move default behavior for nlambda to the eos base class
 
 ### Removed (removing behavior/API/varaibles/...)
 

python/module.hpp

@@ -346,7 +346,7 @@ py::class_<T> eos_class(py::module_ & m, std::string name) {
 
     .def("MinimumDensity", &T::MinimumDensity)
     .def("MinimumTemperature", &T::MinimumTemperature)
-    .def_property_readonly("nlambda", &T::nlambda)
+    .def_property_readonly_static("nlambda", [](py::object) { return T::nlambda(); })
     .def_property_readonly_static("PreferredInput", [](py::object) { return T::PreferredInput(); })
     .def("PrintParams", &T::PrintParams)
     .def("DensityEnergyFromPressureTemperature", [](const T & self, const Real press, const Real temp, py::array_t<Real> lambda) {

singularity-eos/eos/eos_base.hpp

@@ -811,6 +811,7 @@ class EosBase {
     return 0;
   }
   static inline unsigned long max_scratch_size(const unsigned int nelements) { return 0; }
+  constexpr static inline int nlambda() noexcept { return 0.; }
 
   // JMM: EOS's which encapsulate a mix or reactions may wish to vary
   // this.  For example, Helmholtz and StellarCollapse. This isn't the

singularity-eos/eos/eos_carnahan_starling.hpp

@@ -230,8 +230,7 @@ class CarnahanStarling : public EosBase<CarnahanStarling> {
   // Generic functions provided by the base class. These contain e.g. the vector
   // overloads that use the scalar versions declared here
   SG_ADD_BASE_CLASS_USINGS(CarnahanStarling)
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return 0; }
+
   static constexpr unsigned long PreferredInput() { return _preferred_input; }
   PORTABLE_INLINE_FUNCTION void PrintParams() const {
     printf("Carnahan-Starling Parameters:\nGamma = %g\nCv    = %g\nb     = %g\nq     = "

singularity-eos/eos/eos_davis.hpp

@@ -167,8 +167,7 @@ class DavisReactants : public EosBase<DavisReactants> {
   // Generic functions provided by the base class. These contain e.g. the vector
   // overloads that use the scalar versions declared here
   SG_ADD_BASE_CLASS_USINGS(DavisReactants)
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return 0; }
+
   static constexpr unsigned long PreferredInput() { return _preferred_input; }
   PORTABLE_INLINE_FUNCTION void PrintParams() const {
     static constexpr char s1[]{"DavisReactants Params: "};
@@ -308,8 +307,7 @@ class DavisProducts : public EosBase<DavisProducts> {
   // Generic functions provided by the base class. These contain e.g. the vector
   // overloads that use the scalar versions declared here
   SG_ADD_BASE_CLASS_USINGS(DavisProducts)
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return 0; }
+
   static constexpr unsigned long PreferredInput() { return _preferred_input; }
   static inline unsigned long scratch_size(std::string method, unsigned int nelements) {
     return 0;

singularity-eos/eos/eos_electrons.hpp

@@ -192,8 +192,7 @@ class IdealElectrons : public EosBase<IdealElectrons> {
   // here
   SG_ADD_DEFAULT_MEAN_ATOMIC_FUNCTIONS(_AZbar)
   SG_ADD_BASE_CLASS_USINGS(IdealElectrons)
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return 1; }
+  constexpr static inline int nlambda() noexcept { return 1; }
   template <typename T>
   static inline constexpr bool NeedsLambda() {
     return std::is_same<T, IndexableTypes::MeanIonizationState>::value;

singularity-eos/eos/eos_eospac.hpp

@@ -1117,7 +1117,6 @@ class EOSPAC : public EosBase<EOSPAC> {
   }
 
   static constexpr unsigned long PreferredInput() { return _preferred_input; }
-  PORTABLE_INLINE_FUNCTION int nlambda() const noexcept { return 0; }
   inline void Finalize() {
     using namespace EospacWrapper;
     eosSafeDestroy(NT, tablehandle, Verbosity::Quiet);

singularity-eos/eos/eos_gruneisen.hpp

@@ -156,8 +156,7 @@ class Gruneisen : public EosBase<Gruneisen> {
   // overloads that use the scalar versions declared here
   SG_ADD_DEFAULT_MEAN_ATOMIC_FUNCTIONS(_AZbar)
   SG_ADD_BASE_CLASS_USINGS(Gruneisen)
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return 0; }
+
   static constexpr unsigned long PreferredInput() { return _preferred_input; }
   PORTABLE_INLINE_FUNCTION void PrintParams() const {
     static constexpr char s1[]{"Gruneisen Params: "};

singularity-eos/eos/eos_helmholtz.hpp

@@ -458,8 +458,7 @@ class Helmholtz : public EosBase<Helmholtz> {
         options_(rad, gas, coul, ion, ele, verbose, newton_raphson) {}
 
   PORTABLE_INLINE_FUNCTION void CheckParams() const { electrons_.CheckParams(); }
-
-  PORTABLE_INLINE_FUNCTION int nlambda() const noexcept { return 3; }
+  constexpr static inline int nlambda() noexcept { return 3; }
   template <typename T>
   static inline constexpr bool NeedsLambda() {
     return std::is_same<T, IndexableTypes::MeanAtomicMass>::value ||

singularity-eos/eos/eos_ideal.hpp

@@ -173,8 +173,7 @@ class IdealGas : public EosBase<IdealGas> {
   // overloads that use the scalar versions declared here
   SG_ADD_DEFAULT_MEAN_ATOMIC_FUNCTIONS(_AZbar)
   SG_ADD_BASE_CLASS_USINGS(IdealGas)
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return 0; }
+
   static constexpr unsigned long PreferredInput() { return _preferred_input; }
   PORTABLE_INLINE_FUNCTION void PrintParams() const {
     printf("Ideal Gas Parameters:\nGamma = %g\nCv    = %g\n", _gm1 + 1.0, _Cv);

singularity-eos/eos/eos_jwl.hpp

@@ -113,8 +113,7 @@ class JWL : public EosBase<JWL> {
   // overloads that use the scalar versions declared here
   SG_ADD_DEFAULT_MEAN_ATOMIC_FUNCTIONS(_AZbar)
   SG_ADD_BASE_CLASS_USINGS(JWL)
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return 0; }
+
   template <typename Indexer_t = Real *>
   PORTABLE_INLINE_FUNCTION void
   ValuesAtReferenceState(Real &rho, Real &temp, Real &sie, Real &press, Real &cv,

singularity-eos/eos/eos_mgusup.hpp

@@ -152,8 +152,7 @@ class MGUsup : public EosBase<MGUsup> {
   // overloads that use the scalar versions declared here
   SG_ADD_DEFAULT_MEAN_ATOMIC_FUNCTIONS(_AZbar)
   SG_ADD_BASE_CLASS_USINGS(MGUsup)
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return 0; }
+
   static constexpr unsigned long PreferredInput() { return _preferred_input; }
   PORTABLE_INLINE_FUNCTION void PrintParams() const {
     static constexpr char st[]{"MGUsup Params: "};

singularity-eos/eos/eos_noble_abel.hpp

@@ -180,8 +180,7 @@ class NobleAbel : public EosBase<NobleAbel> {
   // overloads that use the scalar versions declared here
   SG_ADD_DEFAULT_MEAN_ATOMIC_FUNCTIONS(_AZbar)
   SG_ADD_BASE_CLASS_USINGS(NobleAbel)
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return 0; }
+
   static constexpr unsigned long PreferredInput() { return _preferred_input; }
   PORTABLE_INLINE_FUNCTION void PrintParams() const {
     printf("Noble-Abel Parameters:\nGamma = %g\nCv    = %g\nb     = %g\nq     = "

singularity-eos/eos/eos_powermg.hpp

@@ -137,8 +137,7 @@ class PowerMG : public EosBase<PowerMG> {
   // overloads that use the scalar versions declared here
   SG_ADD_DEFAULT_MEAN_ATOMIC_FUNCTIONS(_AZbar)
   SG_ADD_BASE_CLASS_USINGS(PowerMG)
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return 0; }
+
   static constexpr unsigned long PreferredInput() { return _preferred_input; }
   PORTABLE_INLINE_FUNCTION void PrintParams() const {
     static constexpr char st[]{"PowerMG Params: "};

singularity-eos/eos/eos_sap_polynomial.hpp

@@ -186,8 +186,7 @@ class SAP_Polynomial : public EosBase<SAP_Polynomial> {
   // overloads that use the scalar versions declared here
   SG_ADD_DEFAULT_MEAN_ATOMIC_FUNCTIONS(_AZbar)
   SG_ADD_BASE_CLASS_USINGS(SAP_Polynomial)
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return 0; }
+
   static constexpr unsigned long PreferredInput() { return _preferred_input; }
   PORTABLE_INLINE_FUNCTION void PrintParams() const {
     printf("SAP_Polynomial EOS Parameters:\n");

singularity-eos/eos/eos_spiner.hpp

@@ -214,8 +214,7 @@ class SpinerEOSDependsRhoT : public EosBase<SpinerEOSDependsRhoT> {
   PORTABLE_FORCEINLINE_FUNCTION
   Real MinimumPressure() const { return PMin_; }
 
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return _n_lambda; }
+  constexpr static inline int nlambda() noexcept { return _n_lambda; }
   template <typename T>
   static inline constexpr bool NeedsLambda() {
     using namespace IndexableTypes;
@@ -498,8 +497,7 @@ class SpinerEOSDependsRhoSie : public EosBase<SpinerEOSDependsRhoSie> {
     return rho_at_pmin_.interpToReal(toLog_(temp, lTOffset_));
   }
 
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return _n_lambda; }
+  constexpr static inline int nlambda() noexcept { return _n_lambda; }
   template <typename T>
   static inline constexpr bool NeedsLambda() {
     return std::is_same<T, IndexableTypes::LogDensity>::value;

singularity-eos/eos/eos_stellar_collapse.hpp

@@ -235,8 +235,7 @@ class StellarCollapse : public EosBase<StellarCollapse> {
   PORTABLE_FORCEINLINE_FUNCTION Real MinimumDensity() const { return rhoMin(); }
   PORTABLE_FORCEINLINE_FUNCTION Real MinimumTemperature() const { return TMin(); }
   PORTABLE_FORCEINLINE_FUNCTION Real MaximumDensity() const { return rhoMax(); }
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return _n_lambda; }
+  constexpr static inline int nlambda() noexcept { return _n_lambda; }
   template <typename T>
   static inline constexpr bool NeedsLambda() {
     using namespace IndexableTypes;

singularity-eos/eos/eos_stiff.hpp

@@ -166,8 +166,7 @@ class StiffGas : public EosBase<StiffGas> {
   // overloads that use the scalar versions declared here
   SG_ADD_BASE_CLASS_USINGS(StiffGas)
   SG_ADD_DEFAULT_MEAN_ATOMIC_FUNCTIONS(_AZbar)
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return 0; }
+
   static constexpr unsigned long PreferredInput() { return _preferred_input; }
   PORTABLE_INLINE_FUNCTION void PrintParams() const {
     printf("Stiff Gas Parameters:\nGamma = %g\nCv    = %g\nPinf  = %g\nq     = "

singularity-eos/eos/eos_variant.hpp

@@ -1321,8 +1321,8 @@ class Variant {
                         eos_);
   }
 
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept {
+  PORTABLE_FORCEINLINE_FUNCTION
+  int nlambda() noexcept {
     return mpark::visit([](const auto &eos) { return eos.nlambda(); }, eos_);
   }
 

singularity-eos/eos/eos_vinet.hpp

@@ -144,8 +144,7 @@ class Vinet : public EosBase<Vinet> {
   // overloads that use the scalar versions declared here
   SG_ADD_BASE_CLASS_USINGS(Vinet)
   SG_ADD_DEFAULT_MEAN_ATOMIC_FUNCTIONS(_AZbar)
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return 0; }
+
   static constexpr unsigned long PreferredInput() { return _preferred_input; }
   PORTABLE_INLINE_FUNCTION void PrintParams() const {
     static constexpr char st[]{"Vinet Params: "};

singularity-eos/eos/modifiers/eos_unitsystem.hpp

@@ -431,8 +431,7 @@ class UnitSystem : public EosBase<UnitSystem<T>> {
                                         std::forward<Transform>(transform));
   }
 
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return t_.nlambda(); }
+  constexpr static inline int nlambda() noexcept { return T::nlambda(); }
   template <typename Indexable>
   static inline constexpr bool NeedsLambda() {
     return T::template NeedsLambda<Indexable>();

singularity-eos/eos/modifiers/floored_energy.hpp

@@ -295,8 +295,7 @@ class FlooredEnergy : public EosBase<FlooredEnergy<T>> {
                                         std::forward<Transform>(transform));
   }
 
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return t_.nlambda(); }
+  constexpr static inline int nlambda() noexcept { return T::nlambda(); }
 
   static constexpr unsigned long PreferredInput() { return T::PreferredInput(); }
 

singularity-eos/eos/modifiers/ramps_eos.hpp

@@ -442,8 +442,7 @@ class BilinearRampEOS : public EosBase<BilinearRampEOS<T>> {
                                         std::forward<Transform>(transform));
   }
 
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return t_.nlambda(); }
+  constexpr static inline int nlambda() noexcept { return T::nlambda(); }
   template <typename Indexable>
   static inline constexpr bool NeedsLambda() {
     return T::template NeedsLambda<Indexable>();

singularity-eos/eos/modifiers/relativistic_eos.hpp

@@ -146,8 +146,7 @@ class RelativisticEOS : public EosBase<RelativisticEOS<T>> {
     t_.FillEos(rho, temp, energy, press, cv, bmod, output, lambda);
   }
 
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return t_.nlambda(); }
+  constexpr static inline int nlambda() noexcept { return T::nlambda(); }
   template <typename Indexable>
   static inline constexpr bool NeedsLambda() {
     return T::template NeedsLambda<Indexable>();

singularity-eos/eos/modifiers/scaled_eos.hpp

@@ -309,8 +309,7 @@ class ScaledEOS : public EosBase<ScaledEOS<T>> {
                                         std::forward<Transform>(transform));
   }
 
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return t_.nlambda(); }
+  constexpr static inline int nlambda() noexcept { return T::nlambda(); }
   template <typename Indexable>
   static inline constexpr bool NeedsLambda() {
     return T::template NeedsLambda<Indexable>();

singularity-eos/eos/modifiers/shifted_eos.hpp

@@ -300,8 +300,7 @@ class ShiftedEOS : public EosBase<ShiftedEOS<T>> {
                                         std::forward<Transform>(transform));
   }
 
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return t_.nlambda(); }
+  constexpr static inline int nlambda() noexcept { return T::nlambda(); }
   template <typename Indexable>
   static inline constexpr bool NeedsLambda() {
     return T::template NeedsLambda<Indexable>();

singularity-eos/eos/modifiers/zsplit_eos.hpp

@@ -224,8 +224,7 @@ class ZSplit : public EosBase<ZSplit<ztype, T>> {
     sie *= scale;
   }
 
-  PORTABLE_INLINE_FUNCTION
-  int nlambda() const noexcept { return 1 + t_.nlambda(); }
+  constexpr static inline int nlambda() noexcept { return 1 + T::nlambda(); }
   template <typename Indexable>
   static inline constexpr bool NeedsLambda() {
     return std::is_same<Indexable, IndexableTypes::MeanIonizationState>::value ||
@@ -282,7 +281,7 @@ class ZSplit : public EosBase<ZSplit<ztype, T>> {
     if constexpr (is_indexable_v<Indexer_t, IndexableTypes::MeanIonizationState>) {
       return std::max(0.0, lambda[IndexableTypes::MeanIonizationState()]);
     } else {
-      return std::max(0.0, lambda[t_.nlambda()]);
+      return std::max(0.0, lambda[T::nlambda()]);
     }
   }
   // TODO(JMM): Runtime?