Skip to content

Commit

Permalink
a few doc nits
Browse files Browse the repository at this point in the history
  • Loading branch information
thchr committed Dec 20, 2023
1 parent b245fac commit cf00fea
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 25 deletions.
24 changes: 8 additions & 16 deletions docs/src/bravais.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,8 @@ reciprocalbasis
```@docs
primitivebasismatrix
transform
primitivize(::Union{AbstractBasis, AbstractPoint}, ::Union{Char, <:Integer})
primitivize(::DirectBasis, ::Union{Char, <:Integer})
primitivize(::ReciprocalBasis, ::Union{Char, <:Integer})
primitivize(::DirectPoint, ::Union{Char, <:Integer})
primitivize(::ReciprocalPoint, ::Union{Char, <:Integer})
conventionalize(::Union{AbstractBasis, AbstractPoint}, ::Union{Char, <:Integer})
conventionalize(::DirectBasis, ::Union{Char, <:Integer})
conventionalize(::ReciprocalBasis, ::Union{Char, <:Integer})
conventionalize(::DirectPoint, ::Union{Char, <:Integer})
conventionalize(::ReciprocalPoint, ::Union{Char, <:Integer})
primitivize
conventionalize
cartesianize
cartesianize!
latticize
Expand All @@ -72,15 +64,15 @@ primitivize(::SymOperation, ::Char, ::Bool)
conventionalize(::SymOperation, ::Char, ::Bool)
```

### `AbstractFourierLattice`
```@docs
primitivize(::AbstractFourierLattice, ::Char)
conventionalize(::AbstractFourierLattice, ::Char)
```

### `AbstractVec`
```@docs
transform(::Crystalline.AbstractVec, ::AbstractMatrix{<:Real})
primitivize(::Crystalline.AbstractVec, ::Char)
conventionalize(::Crystalline.AbstractVec, ::Char)
```

### `AbstractFourierLattice`
```@docs
primitivize(::AbstractFourierLattice, ::Char)
conventionalize(::AbstractFourierLattice, ::Char)
```
7 changes: 3 additions & 4 deletions src/lattices.jl
Original file line number Diff line number Diff line change
Expand Up @@ -184,13 +184,12 @@ end
_orbit(Ws, x)
Computes the orbit of a direct-space point `x` under a set of point-group operations `Ws`,
i.e. computes the set ``{gx | g∈G}`` where `g` denotes elements of the group
`G` composed of all operations in `Ws` (possibly iterated, to ensure
full coverage).
i.e. computes the set {gx | g∈G} where g denotes elements of the group G composed of all
operations in `Ws` (possibly iterated, to ensure full coverage).
It is important that `Ws` and `x` are given in the same basis.
[W' = PWP⁻¹ if the basis change is from coordinates r to r' = Pr, corresponding
[``W' = PWP⁻¹`` if the basis change is from coordinates r to r' = Pr, corresponding
to a new set of basis vectors (x̂')ᵀ=x̂ᵀP; e.g., when going from a direct basis
representation to a Cartesian one, the basis change matrix is P = [R₁ R₂ R₃],
with Rᵢ inserted as column vectors]
Expand Down
6 changes: 3 additions & 3 deletions src/littlegroup_irreps.jl
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ as values.
the matrices associated with `lgir` will be evaluated assuming `αβγ = [0,0,...]`.
## References
The underlying data is sourced from the ISOTROPY ISO-IR dataset. Please cite original
The underlying data is sourced from the ISOTROPY ISO-IR dataset. Please cite the original
reference material associated with ISO-IR:
1. Stokes, Hatch, & Campbell,
Expand Down Expand Up @@ -138,14 +138,14 @@ function (lgir::LGIrrep)(αβγ::Union{AbstractVector{<:Real}, Nothing} = nothin
# server, i.e. has Dᵏ({I|𝐭}) = exp(i𝐤⋅𝐭); but disagrees with several other
# references (e.g. Herring 1937a and Kovalev's book; and even Bilbao's
# own _publications_?!).
# In these other references one take Dᵏ({I|𝐭}) = exp(-i𝐤⋅𝐭), while Inui takes
# In these other references one has Dᵏ({I|𝐭}) = exp(-i𝐤⋅𝐭), while Inui takes
# Dᵏ({I|𝐭}) = exp(i𝐤⋅𝐭) [cf. (11.36)]. The former choice, i.e. Dᵏ({I|𝐭}) =
# exp(-i𝐤⋅𝐭) actually appears more natural, since we usually have symmetry
# operations acting _inversely_ on functions of spatial coordinates and
# Bloch phases exp(i𝐤⋅𝐫).
# Importantly, the exp(i𝐤⋅τ) is also the convention adopted by Stokes et al.
# in Eq. (1) of Acta Cryst. A69, 388 (2013), i.e. in ISOTROPY (also
# expliciated at https://stokes.byu.edu/iso/irtableshelp.php), so, overall,
# explicated at https://stokes.byu.edu/iso/irtableshelp.php), so, overall,
# this is probably the sanest choice for this dataset.
# This weird state of affairs was also noted explicitly by Chen Fang in
# https://doi.org/10.1088/1674-1056/28/8/087102 (near Eqs. (11-12)).
Expand Down
4 changes: 2 additions & 2 deletions src/pointgroup.jl
Original file line number Diff line number Diff line change
Expand Up @@ -417,9 +417,9 @@ function find_isomorphic_parent_pointgroup(g::AbstractVector{SymOperation{D}}) w
end

"""
$TYPEDSIGNATURES --> Vector{UnitRange}
_find_equal_groups_in_sorted(v::AbstractVector) --> Vector{UnitRange}
Returns indices into groups of equal values in `v`. Input `v` *must be* sorted so that
Returns indices into groups of equal values in `v`. Input `v` *must* be sorted so that
identical values are adjacent.
## Example
Expand Down

0 comments on commit cf00fea

Please sign in to comment.