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/SymmetryFromOrbifold.h"
      26              : #include "neml2/tensors/crystallography.h"
      27              : 
      28              : namespace neml2
      29              : {
      30              : register_NEML2_object(SymmetryFromOrbifold);
      31              : 
      32              : OptionSet
      33            2 : SymmetryFromOrbifold::expected_options()
      34              : {
      35            2 :   OptionSet options = UserTensorBase::expected_options();
      36            2 :   options.doc() = "Returns a tensor of symmetry operations for a given symmetr group represented "
      37            2 :                   "in orbifold notation.";
      38              : 
      39            4 :   options.set<std::string>("orbifold");
      40            4 :   options.set("orbifold").doc() =
      41              :       "A string giving the orbifold representation of the group, for example 432 for the typical "
      42            2 :       "cubic crystal system defined by chiral octahedral symmetry";
      43            2 :   return options;
      44            0 : }
      45              : 
      46           55 : SymmetryFromOrbifold::SymmetryFromOrbifold(const OptionSet & options)
      47          220 :   : R2(crystallography::symmetry_operations_from_orbifold(options.get<std::string>("orbifold"))),
      48          110 :     UserTensorBase(options)
      49              : {
      50           55 : }
      51              : } // namespace neml2