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/solid_mechanics/PhaseTransformationEigenstrain.h"
      26              : 
      27              : namespace neml2
      28              : {
      29              : register_NEML2_object(PhaseTransformationEigenstrain);
      30              : 
      31              : OptionSet
      32            2 : PhaseTransformationEigenstrain::expected_options()
      33              : {
      34            2 :   OptionSet options = Eigenstrain::expected_options();
      35            2 :   options.doc() =
      36              :       "Define the (cummulative, as opposed to instantaneous) linear isotropic phase transformation "
      37              :       "(from phase A to phase B) eigenstrain, i.e. \\f$ \\boldsymbol{\\varepsilon}_\\mathrm{PT} = "
      38              :       "\\Delta V f \\boldsymbol{I} \\f$, where \\f$ \\Delta V \\f$ is the volume fraction change "
      39            2 :       "when going from phase A to B, \\f$ f \\f$ is the phase fraction (0 to 1, A to B).";
      40              : 
      41            6 :   options.set_input("volume_fraction_change") = VariableName(STATE, "dv");
      42            4 :   options.set("volume_fraction_change").doc() =
      43            2 :       "Change in volume fraction going from phase A to phase B";
      44              : 
      45            6 :   options.set_input("phase_fraction") = VariableName(STATE, "f");
      46            2 :   options.set("phase_fraction").doc() = "Phase fraction";
      47              : 
      48            2 :   return options;
      49            0 : }
      50              : 
      51            1 : PhaseTransformationEigenstrain::PhaseTransformationEigenstrain(const OptionSet & options)
      52              :   : Eigenstrain(options),
      53            1 :     _f(declare_input_variable<Scalar>("phase_fraction")),
      54            2 :     _dv(declare_input_variable<Scalar>("volume_fraction_change"))
      55              : {
      56            1 : }
      57              : 
      58              : void
      59            2 : PhaseTransformationEigenstrain::set_value(bool out, bool dout_din, bool d2out_din2)
      60              : {
      61            2 :   if (out)
      62            1 :     _eg = _f * _dv * SR2::identity(_f.options());
      63              : 
      64            2 :   if (dout_din)
      65              :   {
      66            1 :     _eg.d(_f) = _dv * SR2::identity(_f.options());
      67            1 :     _eg.d(_dv) = _f * SR2::identity(_f.options());
      68              :   }
      69              : 
      70            2 :   if (d2out_din2)
      71              :   {
      72            0 :     _eg.d(_f, _dv) = SR2::identity(_f.options());
      73            0 :     _eg.d(_dv, _f) = SR2::identity(_f.options());
      74              :   }
      75            2 : }
      76              : }
      77              : // namespace neml2