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/crystallography/CubicCrystal.h"
      26              : 
      27              : #include "neml2/base/Factory.h"
      28              : #include "neml2/tensors/crystallography.h"
      29              : #include "neml2/base/TensorName.h"
      30              : 
      31              : namespace neml2::crystallography
      32              : {
      33              : 
      34              : register_NEML2_object(CubicCrystal);
      35              : 
      36              : OptionSet
      37            2 : CubicCrystal::expected_options()
      38              : {
      39            2 :   OptionSet options = CrystalGeometry::expected_options();
      40            2 :   options.doc() =
      41            2 :       "A specialization of the general CrystalGeometry class defining a cubic crystal system.";
      42              : 
      43            4 :   options.set("crystal_class").suppressed() = true;
      44            4 :   options.set("lattice_vectors").suppressed() = true;
      45              : 
      46            4 :   options.set<TensorName<Scalar>>("lattice_parameter");
      47            2 :   options.set("lattice_parameter").doc() = "The lattice parameter";
      48              : 
      49            2 :   return options;
      50            0 : }
      51              : 
      52           20 : CubicCrystal::CubicCrystal(const OptionSet & options)
      53           20 :   : CubicCrystal(options, options.get<Factory *>("_factory"))
      54              : {
      55           20 : }
      56              : 
      57           20 : CubicCrystal::CubicCrystal(const OptionSet & options, Factory * factory)
      58              :   : CrystalGeometry(options,
      59           80 :                     symmetry_operations_from_orbifold("432"),
      60           40 :                     Vec(ATensor(R2::fill(
      61           40 :                         options.get<TensorName<Scalar>>("lattice_parameter").resolve(factory)))),
      62           40 :                     options.get<TensorName<MillerIndex>>("slip_directions").resolve(factory),
      63          100 :                     options.get<TensorName<MillerIndex>>("slip_planes").resolve(factory))
      64              : {
      65           20 : }
      66              : 
      67              : } // namespace neml2