The code has the following structure

-src: contains OpenFOAM application source code: aerosolChargingFoam
-run: contains run directory for example cases 
 -1.Hoppel_Frick: Bipolar diffusion charging, 0D model verification with Figure 7 of Hoppel & Frick, 1990
 -2.Maisels: Photoelectric charging, 0D model verification with Figure 4 of Maisels et al., 2002          
 -3.Kaminski: Unipolar diffusion charging, with Figure 8 of Kaminski et al., 2012
 -4.bipolarDiffusion3D: 3D tutorial for flow and bipolar diffusion charging
 -5.unipolarDiffusion3D: 3D tutorial for flow and unipolar diffusion charging
 -6.photoelectric3D: 3D tutorial for flow and photoelectric charging


To begin with the code,

1) Download and install OpenFOAM:
    1.1) Download and install the OpenFOAM v6 by The OpenFOAM Foundation on Linux, macOS or Windows (note: these instructions have been validated for OpenFOAM v9, Ubuntu 18.04 LTS)
    1.2) It is recommended that any user of openAerosol should first develop some familiarity with OpenFOAM by working through tutorial cases   

2) Two directories should be present in the openAerosol directory: 'run' and 'src'. The 'src' directory contains all the source code for the aerosolChargingFoam solver and the 'run' directory contains the aerosolChargingFoam tutorial cases.

3) Compile aerosolChargingFoam Code:
    3.1) Navigate to the source code and compile:
        3.1.1) cd src/
        3.1.2) ./Allwmake

4) Run tutorial cases:

A) Hoppel & Frick

cd ../run/Hoppel_Frick
make mesh
make runCharging

Note: should take < 1 min to solve on a laptop

cd run
paraFoam

In Properties panel on left:
	- click 'Apply'
	- scroll down to Fields and select
		-nIonsN
		-nIonsP
		-nPart-5Size1 to nPart-5Size1
	- click 'Apply'
Select Filters > Data Analysis > Plot Data Over Time
In Properties panel on left:
	- click 'Apply'
	- scroll down to Left Axis Range and select
		-Left Axis Log Scale
		-Left Axis Use Custom Range
		-Set Left Axis Range Minimum to 1e7
		-Set Left Axis Range Maximum to 1e12
	- scroll down to Bottom Axis Range and select
		-Bottom Axis Log Scale
		-Bottom Axis Use Custom Range
		-Set Bottom Axis Range Minimum to 0.01
		-Set Bottom Axis Range Maximum to 100

Compare results with Figure 7 of Hoppel & Frick, 1990 (references listed below)

B) Maisels

cd ../run/Maisels
make mesh
make runCharging

Note: should take < 30 seconds to solve on a laptop

cd run
paraFoam

In Properties panel on left:
	- click 'Apply'
	- scroll down to Fields and select
		-CPP
	- click 'Apply'
Select Filters > Data Analysis > Plot Data Over Time
In Properties panel on left:
	- click 'Apply'
	- scroll down to Left Axis Range and select
		-Left Axis Log Scale
		-Left Axis Use Custom Range
		-Set Left Axis Range Minimum to 0.01
		-Set Left Axis Range Maximum to 100
	- scroll down to Bottom Axis Range and select
		-Bottom Axis Log Scale
		-Bottom Axis Use Custom Range
		-Set Bottom Axis Range Minimum to 0.001
		-Set Bottom Axis Range Maximum to 3

Compare results with Figure 4 of Maisels et al., 2002


C) Kaminski

cd ../run/Kaminski
make mesh
make runCharging

Note: should take approximately 10 minutes or less to solve on a laptop

cd run
./dataMerge

Open chargeVsRadius.csv with plotting software of your choice. Note radius is reported in nm rather than diameter.

Compare results with Figure 8 of Kaminski et al., 2012

----------------
For more details, please visit https://openaerosol.sourceforge.io/ and see Woo et al. 2022 (https://doi.org/10.1016/j.cpc.2022.108399)

References:

Hoppel, W. A., & Frick, G. M. (1990). The nonequilibrium character of the aerosol charge distributions produced by neutralizes. Aerosol Science and Technology, 12(3), 471-496.

Maisels, A., Jordan, F., & Fissan, H. (2002). Dynamics of the aerosol particle photocharging process. Journal of applied Physics, 91(5), 3377-3383.

Kaminski, H., Kuhlbusch, T. A., Fissan, H., Ravi, L., Horn, H. G., Han, H. S., ... & Asbach, C. (2012). Mathematical description of experimentally determined charge distributions of a unipolar diffusion charger. Aerosol Science and Technology, 46(6), 708-716.

Woo, M., Schriefl, M.A., Knoll, M., Boies, A.M., Stettler, M.E.J., Hochgreb, S., and Nishida, R.T. (2022). Open-source modelling of aerosol dynamics and computational fluid dynamics: bipolar and unipolar diffusion charging and photoelectric charging. Computer Physics Communications, 278, 108399.