LabeledAxis.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 <map>
 
#include "neml2/misc/types.h"
#include "neml2/base/LabeledAxisAccessor.h"
#include "neml2/tensors/indexing.h"
 
namespace neml2
{
class LabeledAxis;
 
class LabeledAxis
{
public:
  LabeledAxis() = default;
 
  LabeledAxis(LabeledAxisAccessor prefix);
 
  bool is_setup() const { return _setup; }
 
  LabeledAxisAccessor qualify(const LabeledAxisAccessor & accessor) const;
 
  bool has_state() const { return _has_state; }
  bool has_old_state() const { return _has_old_state; }
  bool has_forces() const { return _has_forces; }
  bool has_old_forces() const { return _has_old_forces; }
  bool has_residual() const { return _has_residual; }
  bool has_parameters() const { return _has_parameters; }
 
  LabeledAxis & add_subaxis(const std::string & name);
 
  void add_variable(const LabeledAxisAccessor & name, Size sz);
 
  template <typename T>
  void add_variable(const LabeledAxisAccessor & name);
 
  void setup_layout();
 
  Size size() const;
 
  Size size(const LabeledAxisAccessor & name) const;
 
  indexing::Slice slice(const LabeledAxisAccessor & name) const;
 
  std::size_t nvariable() const;
  bool has_variable(const LabeledAxisAccessor & name) const;
  std::size_t variable_id(const LabeledAxisAccessor & name) const;
  const std::vector<LabeledAxisAccessor> & variable_names() const;
  const std::vector<std::pair<Size, Size>> & variable_slices() const;
  const std::pair<Size, Size> & variable_slice(const LabeledAxisAccessor & name) const;
  const std::vector<Size> & variable_sizes() const;
  Size variable_size(const LabeledAxisAccessor & name) const;
 
  std::size_t nsubaxis() const;
  bool has_subaxis(const LabeledAxisAccessor & name) const;
  std::size_t subaxis_id(const std::string & name) const;
  const std::vector<const LabeledAxis *> & subaxes() const;
  const LabeledAxis & subaxis(const LabeledAxisAccessor & name) const;
  LabeledAxis & subaxis(const LabeledAxisAccessor & name);
  const std::vector<std::string> & subaxis_names() const;
  const std::vector<std::pair<Size, Size>> & subaxis_slices() const;
  std::pair<Size, Size> subaxis_slice(const LabeledAxisAccessor & name) const;
  const std::vector<Size> & subaxis_sizes() const;
  Size subaxis_size(const LabeledAxisAccessor & name) const;
 
  bool equals(const LabeledAxis & other) const;
 
  friend std::ostream & operator<<(std::ostream & os, const LabeledAxis & axis);
 
private:
  void cache_reserved_subaxis(const std::string & axis_name);
 
  void ensure_setup_dbg() const;
 
  bool _setup = false;
 
  const LabeledAxisAccessor _prefix = {};
 
  Size _size = 0;
 
  std::map<std::string, Size> _variables;
 
  std::map<std::string, std::shared_ptr<LabeledAxis>> _subaxes;
 
  std::map<LabeledAxisAccessor, std::size_t> _variable_to_id_map;
  std::vector<LabeledAxisAccessor> _id_to_variable_map;
  std::vector<Size> _id_to_variable_size_map;
  std::vector<std::pair<Size, Size>> _id_to_variable_slice_map;
 
  std::vector<const LabeledAxis *> _sorted_subaxes;
  std::map<std::string, std::size_t> _subaxis_to_id_map;
  std::vector<std::string> _id_to_subaxis_map;
  std::vector<Size> _id_to_subaxis_size_map;
  std::vector<std::pair<Size, Size>> _id_to_subaxis_slice_map;
 
  bool _has_state = false;
  bool _has_old_state = false;
  bool _has_forces = false;
  bool _has_old_forces = false;
  bool _has_residual = false;
  bool _has_parameters = false;
};
 
std::ostream & operator<<(std::ostream & os, const LabeledAxis & axis);
 
bool operator==(const LabeledAxis & a, const LabeledAxis & b);
 
bool operator!=(const LabeledAxis & a, const LabeledAxis & b);
} // namespace neml2