From 810f83534a84b01a0ba49e9d9acee2764c1ec324 Mon Sep 17 00:00:00 2001
From: "Joachim Wuttke (h)" <j.wuttke@fz-juelich.de>
Date: Tue, 28 Apr 2020 16:20:48 +0200
Subject: [PATCH] Core: Add Doxygen comments and TODO notes to create*Lattice
functions
---
Core/Lattice/Lattice.h | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/Core/Lattice/Lattice.h b/Core/Lattice/Lattice.h
index a9527c8a17f..50f3239f75c 100644
--- a/Core/Lattice/Lattice.h
+++ b/Core/Lattice/Lattice.h
@@ -75,16 +75,23 @@ public:
//! Sets a selection rule for the reciprocal vectors
void setSelectionRule(const ISelectionRule& p_selection_rule);
+ //! Returns a primitive cubic (cP) lattice with edge length a.
static Lattice createCubicLattice(double a);
+ //! Returns a face-centered cubic (cF) lattice with edge length a.
static Lattice createFCCLattice(double a);
+ //! Returns a primitive hexagonal (hP) lattice with hexagonal edge a and height c.
static Lattice createHexagonalLattice(double a, double c);
+ //! TODO: Clarify how this is meant: HCP is not a Bravais lattice.
static Lattice createHCPLattice(double a, double c);
+ //! Returns a primitive tetragonal (tP) lattice with square base edge a and height c.
static Lattice createTetragonalLattice(double a, double c);
+ //! Returns a body-centered cubic (cI) lattice with edge length a.
+ //! TODO: Clarify meaning of c
static Lattice createBCTLattice(double a, double c);
void onChange() override;
--
GitLab