Complex Fields (#49)

* Added Complex Field Functionality.

* Update Version Number

* Update ci.yml

* Apply code review suggestions.

* Fixed documation - Final

* Update .gitignore

---------

Co-authored-by: Sebastian Micluța-Câmpeanu <31181429+SebastianM-C@users.noreply.github.com>

Author: toma-vlad

.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.6'
+          - '1'
           - 'nightly'
         os:
           - ubuntu-latest
@@ -34,7 +34,7 @@ jobs:
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.julia-arch }}
-      - uses: actions/cache@v1
+      - uses: actions/cache@v4
         env:
           cache-name: cache-artifacts
         with:

.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 /Manifest.toml
 /dev/
+.vscode

Project.toml

@@ -1,7 +1,7 @@
 name = "LaserTypes"
 uuid = "e07c0bfa-524c-4f35-a151-c3dd916fa2f0"
 authors = ["Sebastian Micluța-Câmpeanu <m.c.sebastian95@gmail.com>", "Petru-Vlad Toma <tomapv@gmail.com>"]
-version = "0.1.8"
+version = "0.1.9"
 
 [deps]
 AutoHashEquals = "15f4f7f2-30c1-5605-9d31-71845cf9641f"
@@ -17,7 +17,7 @@ Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
 UnitfulAtomic = "a7773ee8-282e-5fa2-be4e-bd808c38a91a"
 
 [compat]
-AutoHashEquals = "0.2"
+AutoHashEquals = "2.2"
 CoordinateTransformations = "0.6"
 HypergeometricFunctions = "0.2, 0.3"
 ParallelProcessingTools = "0.4"

docs/make.jl

@@ -17,15 +17,17 @@ makedocs(
             "temporal-profiles.md"
         ],
         "covariant.md",
+        "derived.md",
         "advanced.md"
     ],
-    modules = [LaserTypes]
+    modules = [LaserTypes],
+    checkdocs = :exports
 )
 
 # Documenter can also automatically deploy documentation to gh-pages.
 # See "Hosting Documentation" and deploydocs() in the Documenter manual
 # for more information.
-deploydocs(
-    repo = "github.com/SebastianM-C/LaserTypes.jl",
-    push_preview = true
-)
+# deploydocs(
+#     repo = "github.com/SebastianM-C/LaserTypes.jl",
+#     push_preview = true
+# )

docs/src/advanced.md

@@ -15,4 +15,4 @@ Order = [:type]
 Modules = [LaserTypes]
 Pages = ["src/coords.jl"]
 Order = [:type]
-```
+```

docs/src/derived.md

@@ -0,0 +1,6 @@
+# Derived Properties
+
+```@autodocs
+Modules = [LaserTypes]
+Pages = ["src/derived.jl"]
+```

src/LaserTypes.jl

@@ -2,7 +2,7 @@
 
 module LaserTypes
 
-export E, B,
+export E, B, EB,
     GaussLaser, LaguerreGaussLaser,
     ConstantProfile, GaussProfile, Cos²Profile, QuasiRectangularProfile,
     setup_laser, Fμν, S
@@ -11,16 +11,13 @@ using Unitful
 using UnitfulAtomic
 using UnPack
 using LinearAlgebra
-using HypergeometricFunctions
 using StaticArrays
 using CoordinateTransformations
 using AutoHashEquals
 using ParallelProcessingTools
+using HypergeometricFunctions: _₁F₁, pochhammer
 import PhysicalConstants.CODATA2018: c_0, e, m_e, ε_0, μ_0
 
-const _₁F₁ = HypergeometricFunctions.drummond1F1
-const pochhammer = HypergeometricFunctions.pochhammer
-
 abstract type AbstractLaser end
 abstract type AbstractTemporalProfile end
 

src/electricfield.jl

@@ -1,6 +1,12 @@
 # # Electric Field
 
-function E(r, t, laser)
+E(r, t, laser, symbol::Symbol) = E(r, t, laser, Val(symbol))
+
+function E(r, t, laser, v::Val{T}) where T
+    @error "Got unsupported field type :$T\n Valid arguments are :real and :complex."
+end
+
+function E(r, t, laser, ::Val{:complex})
     R = geometry(laser).rotation_matrix
     r′ = rotate_coords(R, r)
     inv_c = immutable_cache(laser, :inv_c)
@@ -9,11 +15,14 @@ function E(r, t, laser)
         r′ = uconvert.(unit(λ), r′)
     end
 
-    ElectricField = real(E(r′, laser) * g(r′[3], t, laser; inv_c))
+    ElectricField = E(r′, laser) * g(r′[3], t, laser; inv_c)
 
     return inv_rotate(R, ElectricField)
 end
 
+E(r, t, laser) = E(r, t, laser, :real)
+E(r, t, laser, ::Val{:real}) = real(E(r, t, laser, :complex))
+
 function E(x::SVector{4}, laser::AbstractLaser)
     inv_c = immutable_cache(laser, :inv_c)
     r = x[SVector{3}(2,3,4)]

src/faraday.jl

@@ -1,6 +1,12 @@
 # # 4-Potential
 
-function EB(r, t, laser)
+EB(r, t, laser, symbol::Symbol) = EB(r, t, laser, Val(symbol))
+
+function EB(r, t, laser, v::Val{T}) where T
+    @error "Got unsupported field type :$T\n Valid arguments are :real and :complex."
+end
+
+function EB(r, t, laser, ::Val{:complex})
     R = geometry(laser).rotation_matrix
     r′ = rotate_coords(R, r)
     inv_c = immutable_cache(laser, :inv_c)
@@ -9,11 +15,14 @@ function EB(r, t, laser)
         r′ = uconvert.(unit(λ), r′)
     end
 
-    E_B = real.(EB(r′, laser) .* g(r′[end], t, laser; inv_c))
+    E_B = EB(r′, laser) .* g(r′[end], t, laser; inv_c)
 
     return inv_rotate.((R,), E_B)
 end
 
+EB(r, t, laser) = EB(r, t, laser, :real)
+EB(r, t, laser, ::Val{:real}) = real.(EB(r, t, laser, :complex))
+
 function EB(r, laser)
     @assert length(r) == 3 "The laser is only defined in 3D"
     fill!(mutable_cache(laser), r)

src/laguerre-gauss.jl

@@ -200,7 +200,7 @@ function LaguerreGaussLaser(units;
     )
 end
 
-"""
+@doc """
     convert_laser(::Type{GaussLaser}, laser::LaguerreGaussLaser)
 
 Convert a `LaguerreGaussLaser` to a `GaussLaser` with similar parameters.