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/KozenyCarmanPermeability.h"
      26              : #include "neml2/tensors/functions/pow.h"
      27              : 
      28              : namespace neml2
      29              : {
      30              : register_NEML2_object(KozenyCarmanPermeability);
      31              : OptionSet
      32            2 : KozenyCarmanPermeability::expected_options()
      33              : {
      34            2 :   OptionSet options = PorosityPermeabilityRelation::expected_options();
      35            2 :   options.doc() +=
      36              :       " The Kozeny-Carman porosity-permeability relation takes the form of \\f$ K = K_0 "
      37              :       "\\frac{\\varphi^n (1-\\varphi_0^m)}{\\varphi_0^m (1-\\varphi)^n} \\f$ where "
      38              :       "\\f$ n \\f$ and \\f$ m \\f$ are shape parameters. \\f$ varphi_0 \\f$ and \\f$ "
      39            2 :       "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>>("n");
      48            4 :   options.set("n").doc() = "Shape parameter n";
      49              : 
      50            4 :   options.set_parameter<TensorName<Scalar>>("m");
      51            2 :   options.set("m").doc() = "Shape parameter m";
      52              : 
      53            2 :   return options;
      54            0 : }
      55              : 
      56            1 : KozenyCarmanPermeability::KozenyCarmanPermeability(const OptionSet & options)
      57              :   : PorosityPermeabilityRelation(options),
      58            3 :     _K0(declare_parameter<Scalar>("K0", "reference_permeability")),
      59            4 :     _phi0(declare_parameter<Scalar>("phi0", "reference_porosity")),
      60            4 :     _n(declare_parameter<Scalar>("n", "n")),
      61            5 :     _m(declare_parameter<Scalar>("m", "m"))
      62              : {
      63            1 : }
      64              : 
      65              : void
      66            2 : KozenyCarmanPermeability::set_value(bool out, bool dout_din, bool /*d2out_din2*/)
      67              : {
      68            2 :   if (out)
      69            1 :     _K = _K0 * pow(_phi / (1 - _phi), _n) / pow(_phi0 / (1 - _phi0), _m);
      70              : 
      71            2 :   if (dout_din)
      72            4 :     _K.d(_phi) = _K0 / pow(_phi0 / (1 - _phi0), _m) * (_n * pow(_phi / (1 - _phi), _n - 1)) /
      73            5 :                  (1 - _phi) / (1 - _phi);
      74            2 : }
      75              : }