Skip to content

Commit 0f38db7

Browse files
committed
re-add docstring notes re: atomate2
1 parent 4b20351 commit 0f38db7

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

emmet-core/emmet/core/elasticity.py

+13-3
Original file line numberDiff line numberDiff line change
@@ -426,9 +426,19 @@ def generate_derived_fitting_data(
426426
Get the derived fitting data from symmetry operations on the primary fitting data.
427427
428428
It can happen that multiple primary deformations can be mapped to the same derived
429-
deformation from different symmetry operations. In such cases, the stress for a
430-
derived deformation is the average of all derived stresses, each corresponding to a
431-
primary calculation. In doing so, we also check to ensure that:
429+
deformation from different symmetry operations. Ideally, this cannot happen if one
430+
use the same structure to determine all the symmetry operations.
431+
432+
However, this is not the case in atomate, where the deformation tasks are determined
433+
based on the symmetry of the structure before the tight relaxation, which in this
434+
function the structure is the relaxed structure. The symmetries can be different.
435+
436+
In atomate2, this is not a problem, because the deformation tasks are determined
437+
based on the relaxed structure.
438+
439+
To make it work for all cases, the stress for a derived deformation is the average
440+
of all derived stresses, each corresponding to a primary calculation.
441+
In doing so, we also check to ensure that:
432442
1. only independent derived deformations are used
433443
2. for a specific derived strain, a primary deformation is only used (mapped)
434444
once to obtain the average

0 commit comments

Comments
 (0)