Skip to content

Commit cea14a6

Browse files
committed
this is hopeless
1 parent bf5ac41 commit cea14a6

File tree

4 files changed

+19
-7
lines changed

4 files changed

+19
-7
lines changed

docs/src/coalescence.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ Droplets.jl uses the Superdroplet method for coalescence [(Shima et al., 2009)](
55

66
```@autodocs
77
Modules = [Droplets]
8-
Pages = ["src/SDFunc/Coalescence/coalescence.jl"]
9-
8+
Public = true
9+
Pages = ["src/SDFunc/Coalescence/eq_types.jl"]
1010
```

docs/src/condensation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
```@autodocs
44
Modules = [Droplets]
5+
Public = true
56
Pages = ["src/SDFunc/condensation.jl"]
67
78
```

docs/src/kernels.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
```@autodocs
44
Modules = [Droplets]
5+
Public = true
56
Pages = ["src/SDFunc/Coalescence/kernels.jl"]
67
78
```

src/SDfunc/Coalescence/eq_types.jl

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,27 +49,37 @@ Base.@kwdef struct coag_settings{FT<:AbstractFloat}
4949
end
5050

5151
"""
52-
struct droplet_attributes{FT<:AbstractFloat}
52+
abstract type droplet_attributes{FT<:AbstractFloat}
53+
"""
54+
abstract type droplet_attributes{FT<:AbstractFloat} end
5355

54-
A struct representing the attributes of a droplet.
56+
"""
57+
struct simple_droplet_attributes{FT<:AbstractFloat} <:droplet_attributes{FT}
58+
59+
A struct of type droplet_attributes representing the attributes of a droplet.
5560
5661
Fields:
5762
- FT: AbstractFloat.
5863
- ξ: Vector of integers representing the multiplicity of each droplet.
59-
- R: Vector of floats representing the radius of each droplet.
6064
- X: Vector of floats representing the volume of each droplet.
6165
6266
"""
63-
abstract type droplet_attributes{FT<:AbstractFloat} end
6467

6568
struct simple_droplet_attributes{FT<:AbstractFloat} <:droplet_attributes{FT}
6669
ξ::Vector{Int}
6770
X::Vector{FT}
6871
end
6972

70-
# Constructor function for droplet_attributes
73+
"""
74+
droplet_attributes{FT}(ξ::Vector{Int}, X::Vector{FT}) where {FT<:AbstractFloat}
75+
Create a new instance of simple_droplet_attributes with the given multiplicity and volume vectors.
76+
"""
7177
droplet_attributes{FT}::Vector{Int}, X::Vector{FT}) where {FT<:AbstractFloat} =
7278
simple_droplet_attributes{FT}(ξ, X)
79+
"""
80+
droplet_attributes(ξ::Vector{Int}, X::Vector{FT}) where {FT<:AbstractFloat}
81+
Create a new instance of simple_droplet_attributes with the given multiplicity and volume vectors.
82+
"""
7383
droplet_attributes::Vector{Int}, X::Vector{FT}) where {FT<:AbstractFloat} =
7484
simple_droplet_attributes{FT}(ξ, X)
7585

0 commit comments

Comments
 (0)