Skip to content

Commit cc18b52

Browse files
committed
add a few breadcrumbs to mspacegroup in docs
1 parent 76c7af9 commit cc18b52

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

docs/src/groups.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Groups
22
All groups in Crystalline are concrete instances of the abstract supertype [`Crystalline.AbstractGroup{D}`](@ref), referring to a group in `D` dimensions. `Crystalline.AbstractGroup{D}` is itself a subtype of `AbstractVector{SymOperation{D}}`.
3-
Crystalline currently supports five group types: [`SpaceGroup`](@ref), [`PointGroup`](@ref), [`LittleGroup`](@ref), [`SubperiodicGroup`](@ref) and [`SiteGroup`](@ref).
3+
Crystalline currently supports five group types: [`SpaceGroup`](@ref), [`PointGroup`](@ref), [`LittleGroup`](@ref), [`SubperiodicGroup`](@ref), [`SiteGroup`](@ref), and [`MSpaceGroup`](@ref).
44

55
## Example: space groups
66

@@ -40,4 +40,7 @@ ops = generators(sgnum, SpaceGroup{D})
4040
To generate a group from a list of generators, we can use the [`generate`](@ref) method. As an example, we can verify that `ops` in fact returns symmetry operations identical to those in `sg`:
4141
```@example spacegroup
4242
generate(ops)
43-
```
43+
```
44+
45+
## Magnetic space groups
46+
Magnetic space groups are accessible via [`mspacegroup`](@ref).

src/magnetic/types.jl

+6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# --- MSymOperation ---
2+
"""
3+
$(TYPEDEF)$(TYPEDFIELDS)
4+
"""
25
struct MSymOperation{D} <: AbstractOperation{D}
36
op :: SymOperation{D}
47
tr :: Bool
@@ -33,6 +36,9 @@ end
3336
# The `num` field of `MSpaceGroup` gives the the two BNS numbers:
3437
# - `num[1]`: F space-group associated number
3538
# - `num[2]`: crystal-system sequential number
39+
"""
40+
$(TYPEDEF)$(TYPEDFIELDS)
41+
"""
3642
struct MSpaceGroup{D} <: AbstractGroup{D, MSymOperation{D}}
3743
num :: Tuple{Int, Int}
3844
operations :: Vector{MSymOperation{D}}

0 commit comments

Comments
 (0)