Line data    Source code

       1              : // Copyright 2024, UChicago Argonne, LLC
       2              : // All Rights Reserved
       3              : // Software Name: NEML2 -- the New Engineering material Model Library, version 2
       4              : // By: Argonne National Laboratory
       5              : // OPEN SOURCE LICENSE (MIT)
       6              : //
       7              : // Permission is hereby granted, free of charge, to any person obtaining a copy
       8              : // of this software and associated documentation files (the "Software"), to deal
       9              : // in the Software without restriction, including without limitation the rights
      10              : // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
      11              : // copies of the Software, and to permit persons to whom the Software is
      12              : // furnished to do so, subject to the following conditions:
      13              : //
      14              : // The above copyright notice and this permission notice shall be included in
      15              : // all copies or substantial portions of the Software.
      16              : //
      17              : // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
      18              : // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
      19              : // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
      20              : // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
      21              : // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
      22              : // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
      23              : // THE SOFTWARE.
      24              : 
      25              : #include "neml2/user_tensors/IdentityTensor.h"
      26              : 
      27              : namespace neml2
      28              : {
      29              : register_NEML2_object(IdentityTensor);
      30              : 
      31              : OptionSet
      32            2 : IdentityTensor::expected_options()
      33              : {
      34            2 :   OptionSet options = UserTensorBase::expected_options();
      35            2 :   options.doc() = "Construct an identity Tensor with given batch shape.";
      36              : 
      37            6 :   options.set<TensorShape>("batch_shape") = {};
      38            4 :   options.set("batch_shape").doc() = "Batch shape";
      39              : 
      40            4 :   options.set<Size>("n");
      41            4 :   options.set("n").doc() =
      42            2 :       "Diagonal size of the identity tensor, i.e., base shape of the identity tensor will be (n,n)";
      43              : 
      44            2 :   return options;
      45            0 : }
      46              : 
      47            1 : IdentityTensor::IdentityTensor(const OptionSet & options)
      48              :   : Tensor(Tensor::identity(
      49            3 :         options.get<TensorShape>("batch_shape"), options.get<Size>("n"), default_tensor_options())),
      50            4 :     UserTensorBase(options)
      51              : {
      52            1 : }
      53              : } // namespace neml2