IdentityBatchTensor.cxx

// Copyright 2023, 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.
 
#include "neml2/tensors/user_tensors/IdentityBatchTensor.h"
 
namespace neml2
{
register_NEML2_object(IdentityBatchTensor);
 
OptionSet
IdentityBatchTensor::expected_options()
{
  OptionSet options = UserTensor::expected_options();
  options.doc() = "Construct an identity BatchTensor with given batch shape.";
 
  options.set<TorchShape>("batch_shape") = {};
  options.set("batch_shape").doc() = "Batch shape";
 
  options.set<TorchSize>("n");
  options.set("n").doc() =
      "Diagonal size of the identity tensor, i.e., base shape of the identity tensor will be (n,n)";
 
  return options;
}
 
IdentityBatchTensor::IdentityBatchTensor(const OptionSet & options)
  : BatchTensor(BatchTensor::identity(options.get<TorchShape>("batch_shape"),
                                      options.get<TorchSize>("n"),
                                      default_tensor_options())),
    UserTensor(options)
{
}
} // namespace neml2