18561934460

Committed 16 Oct 2025 12:54PM UTC coverage: 65.961% (-0.03%) from 65.988%

Build # 18561934460

Build Type

push

github

Committed by

web-flow

Commit Message

Removed `test_case` and made several dispatches more precise (#104)

* Removed `test_case`.

* Made several dispatches more precise.

* Removed `examples.md` (was comitted by accident).

* Renamed `AbstractVariable` to `AbstractPredictand` and removed some of its subtypes (these are direct subtypes of `Any` now).

* Some simplifications and additional comments in initialize_rays!.

* Corrected a few typos.

* Moved the namelist parameter "model" to AtmosphereNamelist and removed SettingNamelist. Reformatted the code.

Run Details

104 of 119 new or added lines in 44 files covered. (87.39%)

4 existing lines in 4 files now uncovered.

4951 of 7506 relevant lines covered (65.96%)

1423740.77 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

42.86

/src/Types/TracerTypes/TracerForcings.jl

"""
```julia
TracerForcings{A <: TracerWKBImpact}
```

Container for `TracerWKBImpact` instance with all necessary terms for the right-hand side of the tracer equation.

```julia
TracerForcings(namelists::Namelists, domain::Domain)::TracerForcings
```

Construct a `TracerForcings` instance set according to the model configuration.

```julia
TracerForcings(
    namelists::Namelists,
    domain::Domain,
    tracer_setup::NoTracer,
)::TracerForcings
```

Construct a `TracerForcings` instance for configurations without tracer transport.

```julia
TracerForcings(
    namelists::Namelists,
    domain::Domain,
    tracer_setup::TracerOn,
)::TracerForcings
```

Construct a `TracerForcings` instance for configurations with tracer transport.

```julia
TracerForcings(domain::Domain, wkb_mode::NoWKB)::TracerForcings
```

Construct a `TracerForcings` instance for configurations without WKB model.

```julia
TracerForcings(
    domain::Domain,
    wkb_mode::Union{SteadyState, SingleColumn, MultiColumn},
)::TracerForcings
```

Construct a `TracerForcings` instance for configurations with tracer transport and WKB model.

# Fields

  - `chiq0::A`: Leading-order tracer forcings.

# Arguments:

  - `namelists`: Namelists with all model parameters.

  - `domain`: Collection of domain-decomposition and MPI-communication parameters.

  - `tracer_setup`: General tracer-transport configuration.

  - `wkb_mode`: Approximations used by MSGWaM.

# See also:

  - [`PinCFlow.Types.TracerTypes.TracerWKBImpact`](@ref)
"""
struct TracerForcings{A <: TracerWKBImpact}
    chiq0::A
end

function TracerForcings(namelists::Namelists, domain::Domain)::TracerForcings
    (; tracer_setup) = namelists.tracer

    return TracerForcings(namelists, domain, tracer_setup)
end

function TracerForcings(
    namelists::Namelists,
    domain::Domain,
    tracer_setup::NoTracer,
)::TracerForcings
    return TracerForcings(
        [TracerWKBImpact(0, 0, 0) for field in fieldnames(TracerForcings)]...,
    )
end

function TracerForcings(
    namelists::Namelists,
    domain::Domain,
    tracer_setup::TracerOn,
)::TracerForcings
    (; wkb_mode) = namelists.wkb

    return TracerForcings(domain, wkb_mode)
end

function TracerForcings(domain::Domain, wkb_mode::NoWKB)::TracerForcings
    return TracerForcings(
        [TracerWKBImpact(0, 0, 0) for field in fieldnames(TracerForcings)]...,
    )
end

function TracerForcings(
    domain::Domain,
    wkb_mode::Union{SteadyState, SingleColumn, MultiColumn},
)::TracerForcings
    (; nxx, nyy, nzz) = domain

    return TracerForcings(
        [
            TracerWKBImpact(nxx, nyy, nzz) for
            field in fieldnames(TracerForcings)
        ]...,
    )
end

1	"""
2	```julia
3	TracerForcings{A <: TracerWKBImpact}
4	```
5
6	Container for `TracerWKBImpact` instance with all necessary terms for the right-hand side of the tracer equation.
7
8	```julia
9	TracerForcings(namelists::Namelists, domain::Domain)::TracerForcings
10	```
11
12	Construct a `TracerForcings` instance set according to the model configuration.
13
14	```julia
15	TracerForcings(
16	namelists::Namelists,
17	domain::Domain,
18	tracer_setup::NoTracer,
19	)::TracerForcings
20	```
21
22	Construct a `TracerForcings` instance for configurations without tracer transport.
23
24	```julia
25	TracerForcings(
26	namelists::Namelists,
27	domain::Domain,
28	tracer_setup::TracerOn,
29	)::TracerForcings
30	```
31
32	Construct a `TracerForcings` instance for configurations with tracer transport.
33
34	```julia
35	TracerForcings(domain::Domain, wkb_mode::NoWKB)::TracerForcings
36	```
37
38	Construct a `TracerForcings` instance for configurations without WKB model.
39
40	```julia
41	TracerForcings(
42	domain::Domain,
43	wkb_mode::Union{SteadyState, SingleColumn, MultiColumn},
44	)::TracerForcings
45	```
46
47	Construct a `TracerForcings` instance for configurations with tracer transport and WKB model.
48
49	# Fields
50
51	- `chiq0::A`: Leading-order tracer forcings.
52
53	# Arguments:
54
55	- `namelists`: Namelists with all model parameters.
56
57	- `domain`: Collection of domain-decomposition and MPI-communication parameters.
58
59	- `tracer_setup`: General tracer-transport configuration.
60
61	- `wkb_mode`: Approximations used by MSGWaM.
62
63	# See also:
64
65	- [`PinCFlow.Types.TracerTypes.TracerWKBImpact`](@ref)
66	"""
67	struct TracerForcings{A <: TracerWKBImpact}
68	chiq0::A	6✔
69	end
70
71	function TracerForcings(namelists::Namelists, domain::Domain)::TracerForcings	6✔
72	(; tracer_setup) = namelists.tracer	6✔
73
74	return TracerForcings(namelists, domain, tracer_setup)	6✔
75	end
76
77	function TracerForcings(	6✔
78	namelists::Namelists,
79	domain::Domain,
80	tracer_setup::NoTracer,
81	)::TracerForcings
82	return TracerForcings(	6✔
83	[TracerWKBImpact(0, 0, 0) for field in fieldnames(TracerForcings)]...,
84	)
85	end
86
87	function TracerForcings(	×
88	namelists::Namelists,
89	domain::Domain,
90	tracer_setup::TracerOn,
91	)::TracerForcings
NEW 92	(; wkb_mode) = namelists.wkb	×
93
NEW 94	return TracerForcings(domain, wkb_mode)	×
95	end
96
NEW 97	function TracerForcings(domain::Domain, wkb_mode::NoWKB)::TracerForcings	×
UNCOV 98	return TracerForcings(	×
99	[TracerWKBImpact(0, 0, 0) for field in fieldnames(TracerForcings)]...,
100	)
101	end
102
103	function TracerForcings(	×
104	domain::Domain,
105	wkb_mode::Union{SteadyState, SingleColumn, MultiColumn},
106	)::TracerForcings
107	(; nxx, nyy, nzz) = domain	×
108
109	return TracerForcings(	×
110	[
111	TracerWKBImpact(nxx, nyy, nzz) for
112	field in fieldnames(TracerForcings)
113	]...,
114	)
115	end

Atmospheric-Dynamics-GUF / PinCFlow.jl / 18561934460

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous