latticegpu.jl/docs/src/fields.md
Alberto Ramos 651891f95a Added documentation for most modules
Only Spinors and Dirac are missing.
2023-12-13 14:45:45 +01:00

26 lines
842 B
Markdown

# Lattice fields
The module `Fields` include simple routines to define a few typical
fields. Fields are simple `CuArray` types with special memory
layout. A field always has an associated elemental type (i.e. for
gauge fields `SU3`, for scalar fields `Float64`). We have:
- scalar fields: One elemental type in each spacetime point.
- vector field: One elemental type at each spacetime point and
direction.
- `N` scalar fields: `N` elemental types at each spacetime point.
Fields can have **naturaL indexing**, where the memory layout follows
the point-in-block and block indices (see
[`SpaceParm`](@ref)). Fields can also have **lexicographic indexing**,
where points are labelled by a D-dimensional index (see [`scalar_field_point`](@ref)).
## Initialization
```@docs
scalar_field
vector_field
nscalar_field
scalar_field_point
```