NEML2 2.0.0
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
crystallography.h
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#pragma once
26
27#include "neml2/tensors/R2.h"
28
29namespace neml2
30{
31class R2;
32namespace crystallography
33{
35{
36constexpr Real a = 0.7071067811865476;
37constexpr Real b = 0.8660254037844386;
38constexpr Real h = 0.5;
39constexpr Real o = 1.0;
40constexpr Real z = 0.0;
41
44
47
50} // namespace crystal_symmetry_operators
51
53R2 symmetry_operations_from_orbifold(const std::string & orbifold,
54 const TensorOptions & options = default_tensor_options());
55
57Vec unique_bidirectional(const R2 & ops, const Vec & inp);
58
59} // namespace crystallography
60} // namespace neml2
A batched quaternion.
Definition Quaternion.h:45
Second order tensor without symmetry.
Definition R2.h:42
3-vector.
Definition Vec.h:42
constexpr Real o
Definition crystallography.h:39
constexpr Real z
Definition crystallography.h:40
constexpr Real a
Definition crystallography.h:36
Quaternion hexagonal(const TensorOptions &options)
hexagonal symmetry operators
Definition crystallography.cxx:51
constexpr Real h
Definition crystallography.h:38
constexpr Real b
Definition crystallography.h:37
Quaternion cubic(const TensorOptions &options)
cubic symmetry operators
Definition crystallography.cxx:69
Quaternion tetragonal(const TensorOptions &options)
tetragonal symmetry operators
Definition crystallography.cxx:37
Definition CrystalGeometry.cxx:39
Vec unique_bidirectional(const R2 &ops, const Vec &inp)
Helper to return all symmetrically-equivalent directions from a cartesian vector.
Definition crystallography.cxx:127
R2 symmetry_operations_from_orbifold(const std::string &orbifold, const TensorOptions &options)
Helper function to return the symmetry operators given the Orbifold notation.
Definition crystallography.cxx:82
Definition DiagnosticsInterface.cxx:30
TensorOptions default_tensor_options()
Default floating point tensor options.
Definition defaults.cxx:44
double Real
Definition types.h:68
c10::TensorOptions TensorOptions
Definition types.h:63