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/FillR2.h"
      26              : #include "neml2/tensors/Scalar.h"
      27              : #include "neml2/misc/assertions.h"
      28              : 
      29              : namespace neml2
      30              : {
      31              : register_NEML2_object(FillR2);
      32              : 
      33              : OptionSet
      34            2 : FillR2::expected_options()
      35              : {
      36            2 :   OptionSet options = UserTensorBase::expected_options();
      37            2 :   options.doc() = "Construct a R2 with a vector of Scalars. The vector length must be 1, 3, 6, or "
      38              :                   "9. When vector length is 1, the Scalar value is used to fill the diagonals; "
      39              :                   "when vector length is 3, the Scalar values are used to fill the respective "
      40              :                   "diagonal entries; when vector length is 6, the Scalar values are used to fill "
      41              :                   "the tensor following the Voigt notation; when vector length is 9, the Scalar "
      42            2 :                   "values are used to fill the tensor in the row-major fashion.";
      43              : 
      44            4 :   options.set<std::vector<TensorName<Scalar>>>("values");
      45            2 :   options.set("values").doc() = "Scalars used to fill the R2";
      46              : 
      47            2 :   return options;
      48            0 : }
      49              : 
      50           28 : FillR2::FillR2(const OptionSet & options)
      51              :   : UserTensorBase(options),
      52           56 :     R2(fill(options.get<std::vector<TensorName<Scalar>>>("values")))
      53              : {
      54           28 : }
      55              : 
      56              : R2
      57           28 : FillR2::fill(const std::vector<TensorName<Scalar>> & values) const
      58              : {
      59           28 :   auto * f = factory();
      60           28 :   neml_assert(f, "Internal error: factory != nullptr");
      61              : 
      62           28 :   if (values.size() == 1)
      63            1 :     return R2::fill(values[0].resolve(f));
      64           27 :   if (values.size() == 3)
      65            1 :     return R2::fill(values[0].resolve(f), values[1].resolve(f), values[2].resolve(f));
      66           26 :   if (values.size() == 6)
      67            1 :     return R2::fill(values[0].resolve(f),
      68            1 :                     values[1].resolve(f),
      69            1 :                     values[2].resolve(f),
      70            1 :                     values[3].resolve(f),
      71            1 :                     values[4].resolve(f),
      72            1 :                     values[5].resolve(f));
      73           25 :   if (values.size() == 9)
      74           25 :     return R2::fill(values[0].resolve(f),
      75           25 :                     values[1].resolve(f),
      76           25 :                     values[2].resolve(f),
      77           25 :                     values[3].resolve(f),
      78           25 :                     values[4].resolve(f),
      79           25 :                     values[5].resolve(f),
      80           25 :                     values[6].resolve(f),
      81           25 :                     values[7].resolve(f),
      82           25 :                     values[8].resolve(f));
      83              : 
      84            0 :   neml_assert(false,
      85              :               "Number of values must be 1, 3, 6, or 9, but ",
      86            0 :               values.size(),
      87              :               " values are provided.");
      88              : 
      89            0 :   return R2();
      90              : }
      91              : } // namespace neml2