NEML2 1.4.0
Loading...
Searching...
No Matches
SymmetryFromOrbifold.cxx
1// Copyright 2023, 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/user_tensors/SymmetryFromOrbifold.h"
26
27#include "neml2/models/crystallography/crystallography.h"
28
29namespace neml2
30{
31namespace crystallography
32{
33register_NEML2_object(SymmetryFromOrbifold);
34
37{
39 options.doc() = "Returns a tensor of symmetry operations for a given symmetr group represented "
40 "in orbifold notation.";
41
42 options.set<std::string>("orbifold");
43 options.set("orbifold").doc() =
44 "A string giving the orbifold representation of the group, for example 432 for the typical "
45 "cubic crystal system defined by chiral octahedral symmetry";
46 return options;
47}
48
50 : R2(symmetry_operations_from_orbifold(options.get<std::string>("orbifold"))),
51 UserTensor(options)
52{
53}
54}
55} // namespace neml2
The wrapper (decorator) for cross-referencing unresolved values at parse time.
Definition CrossRef.h:52
A custom map-like data structure. The keys are strings, and the values can be nonhomogeneously typed.
Definition OptionSet.h:59
const std::string & doc() const
A readonly reference to the option set's docstring.
Definition OptionSet.h:91
T & set(const std::string &)
Definition OptionSet.h:436
A basic R2.
Definition R2.h:42
Definition UserTensor.h:33
static OptionSet expected_options()
Definition UserTensor.cxx:30
Provide the correct symmetry operators for a given crystal class.
Definition SymmetryFromOrbifold.h:39
SymmetryFromOrbifold(const OptionSet &options)
Setup the symmetry operators.
Definition SymmetryFromOrbifold.cxx:49
static OptionSet expected_options()
Definition SymmetryFromOrbifold.cxx:36
R2 symmetry_operations_from_orbifold(std::string orbifold, const torch::TensorOptions &options)
Helper function to return the symmetry operators given the Orbifold notation.
Definition crystallography.cxx:84
Definition CrossRef.cxx:32