TensorName.h

// Copyright 2024, UChicago Argonne, LLC
// All Rights Reserved
// Software Name: NEML2 -- the New Engineering material Model Library, version 2
// By: Argonne National Laboratory
// OPEN SOURCE LICENSE (MIT)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#pragma once
 
#include "neml2/misc/types.h"
#include "neml2/tensors/tensors.h"
 
namespace neml2
{
class Model;
class Factory;
 
template <typename T>
struct TensorName
{
public:
  TensorName() = default;
 
  TensorName(std::string raw)
    : _raw_str(std::move(raw))
  {
  }
 
  TensorName & operator=(const std::string & other)
  {
    _raw_str = other;
    return *this;
  }
 
  const T & resolve(Factory * factory = nullptr) const;
  const T & resolve(Model * caller, const std::string & pname) const;
 
  bool operator==(const TensorName & other) const { return _raw_str == other.raw(); }
 
  std::string & raw() { return _raw_str; }
  const std::string & raw() const { return _raw_str; }
 
private:
  T resolve_number(double val) const;
 
  std::string _raw_str;
 
  mutable T _value;
 
  mutable std::shared_ptr<T> _tensor = nullptr;
};
 
// Export TensorName so other TU don't repeat the instantiation
#define EXPORT_TENSORNAME(T) extern template struct TensorName<T>
FOR_ALL_TENSORBASE(EXPORT_TENSORNAME);
#undef EXPORT_TENSORNAME
 
template <typename T>
std::stringstream &
operator>>(std::stringstream & ss, TensorName<T> & t)
{
  ss >> t.raw();
  return ss;
}
 
template <typename T>
std::ostream &
operator<<(std::ostream & os, const TensorName<T> & t)
{
  os << t.raw();
  return os;
}
} // namespace neml2