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/porous_flow/ExponentialLawPermeability.h"
      26              : #include "neml2/tensors/functions/exp.h"
      27              : #include "neml2/tensors/assertions.h"
      28              : 
      29              : namespace neml2
      30              : {
      31              : register_NEML2_object(ExponentialLawPermeability);
      32              : OptionSet
      33            2 : ExponentialLawPermeability::expected_options()
      34              : {
      35            2 :   OptionSet options = PorosityPermeabilityRelation::expected_options();
      36            2 :   options.doc() +=
      37              :       " The exponential porosity-permeability relation takes the form of \\f$ K_0 \\exp \\left[ "
      38              :       "a(\\varphi_o-\\varphi) \\right] \\f$ where \\f$ a \\f$ is the scaling parameter; \\f$ "
      39            2 :       "\\varphi_0 \\f$ and \\f$ K_0 \\f$ are the reference porosity and permeability respectively.";
      40              : 
      41            4 :   options.set_parameter<TensorName<Scalar>>("reference_permeability");
      42            4 :   options.set("reference_permeability").doc() = "the reference permeability";
      43              : 
      44            4 :   options.set_parameter<TensorName<Scalar>>("reference_porosity");
      45            4 :   options.set("reference_porosity").doc() = "the reference porosity";
      46              : 
      47            4 :   options.set_parameter<TensorName<Scalar>>("scale");
      48            2 :   options.set("scale").doc() = "Scaling constant in the exponential law";
      49              : 
      50            2 :   return options;
      51            0 : }
      52              : 
      53            1 : ExponentialLawPermeability::ExponentialLawPermeability(const OptionSet & options)
      54              :   : PorosityPermeabilityRelation(options),
      55            3 :     _K0(declare_parameter<Scalar>("K0", "reference_permeability")),
      56            4 :     _phi0(declare_parameter<Scalar>("phi0", "reference_porosity")),
      57            5 :     _a(declare_parameter<Scalar>("a", "scale"))
      58              : {
      59            1 : }
      60              : 
      61              : void
      62            2 : ExponentialLawPermeability::set_value(bool out, bool dout_din, bool /*d2out_din2*/)
      63              : {
      64            2 :   if (out)
      65            1 :     _K = _K0 * exp(-_a * (_phi - _phi0));
      66              : 
      67            2 :   if (dout_din)
      68            1 :     _K.d(_phi) = _K0 * exp(-_a * (_phi - _phi0)) * -_a;
      69            2 : }
      70              : }