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/models/Determinant.h"
      26              : #include "neml2/tensors/SR2.h"
      27              : #include "neml2/tensors/R2.h"
      28              : 
      29              : namespace neml2
      30              : {
      31              : using R2Determinant = Determinant<R2>;
      32              : using SR2Determinant = Determinant<SR2>;
      33              : register_NEML2_object(R2Determinant);
      34              : register_NEML2_object(SR2Determinant);
      35              : 
      36              : template <typename T>
      37              : OptionSet
      38            4 : Determinant<T>::expected_options()
      39              : {
      40            4 :   auto options = Model::expected_options();
      41            4 :   options.doc() = "Calculate the Jacobian of a second order tensor.";
      42              : 
      43           12 :   options.set_input("input") = VariableName(STATE, "F");
      44            4 :   options.set("input").doc() = "The second order tensor to calculate the determinant of";
      45              : 
      46           12 :   options.set_output("determinant") = VariableName(STATE, "J");
      47            4 :   options.set("determinant").doc() = "The determinant of the input tensor";
      48              : 
      49            4 :   return options;
      50            0 : }
      51              : 
      52              : template <typename T>
      53            1 : Determinant<T>::Determinant(const OptionSet & options)
      54              :   : Model(options),
      55            1 :     _F(declare_input_variable<T>("input")),
      56            2 :     _J(declare_output_variable<Scalar>("determinant"))
      57              : {
      58            1 : }
      59              : 
      60              : template <typename T>
      61              : void
      62            2 : Determinant<T>::set_value(bool out, bool dout_din, bool /*d2out_din2*/)
      63              : {
      64            2 :   if (out)
      65            1 :     _J = T(_F).det();
      66              : 
      67            2 :   if (dout_din)
      68            1 :     if (_F.is_dependent())
      69            1 :       _J.d(_F) = T(_F).det() * T(_F).inverse().transpose();
      70            2 : }
      71              : 
      72              : template class Determinant<R2>;
      73              : template class Determinant<SR2>;
      74              : } // namespace neml2