NEML2 1.4.0
Loading...
Searching...
No Matches
crystallography.h
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#pragma once
26
27#include <torch/torch.h>
28#include "neml2/tensors/R2.h"
29
30namespace neml2
31{
32class R2;
33namespace crystallography
34{
35namespace crystal_symmetry_operators
36{
37constexpr Real a = 0.7071067811865476;
38constexpr Real b = 0.8660254037844386;
39constexpr Real h = 0.5;
40constexpr Real o = 1.0;
41constexpr Real z = 0.0;
42
44const torch::Tensor tetragonal(const torch::TensorOptions & options = default_tensor_options());
45
47const torch::Tensor hexagonal(const torch::TensorOptions & options = default_tensor_options());
48
50const torch::Tensor cubic(const torch::TensorOptions & options = default_tensor_options());
51} // namespace crystal_symmetry_operators
52
54R2
56 const torch::TensorOptions & options = default_tensor_options());
57
59Vec unique_bidirectional(const R2 & ops, const Vec & inp);
60
61} // namespace crystallography
62} // namespace neml2
The wrapper (decorator) for cross-referencing unresolved values at parse time.
Definition CrossRef.h:52
A basic R2.
Definition R2.h:42
The (logical) vector.
Definition Vec.h:42
constexpr Real o
Definition crystallography.h:40
constexpr Real z
Definition crystallography.h:41
constexpr Real a
Definition crystallography.h:37
const torch::Tensor hexagonal(const torch::TensorOptions &options)
hexagonal symmetry operators
Definition crystallography.cxx:53
constexpr Real h
Definition crystallography.h:39
constexpr Real b
Definition crystallography.h:38
const torch::Tensor tetragonal(const torch::TensorOptions &options)
tetragonal symmetry operators
Definition crystallography.cxx:39
const torch::Tensor cubic(const torch::TensorOptions &options)
cubic symmetry operators
Definition crystallography.cxx:71
Vec unique_bidirectional(const R2 &ops, const Vec &inp)
Helper to return all symmetrically-equivalent directions from a cartesian vector.
Definition crystallography.cxx:147
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
const torch::TensorOptions default_tensor_options()
Definition types.cxx:30