From 1872ea5057211c6ed38ce866d44d69e1eb565e1a Mon Sep 17 00:00:00 2001 From: Ramzi Kutteh Date: Thu, 27 Jun 2024 20:22:25 +1000 Subject: [PATCH 1/2] Add a table of physical constants to the user guide --- .../docs/user_guide/constants/index.md | 16 +++++++++++++ .../constants/mathematical_constants.md | 5 ++++ .../constants/physical_constants.md | 23 +++++++++++++++++++ documentation/mkdocs.yml | 4 ++++ src/params/cable_phys_constants_mod.F90 | 16 ++++++------- 5 files changed, 56 insertions(+), 8 deletions(-) create mode 100644 documentation/docs/user_guide/constants/index.md create mode 100644 documentation/docs/user_guide/constants/mathematical_constants.md create mode 100644 documentation/docs/user_guide/constants/physical_constants.md diff --git a/documentation/docs/user_guide/constants/index.md b/documentation/docs/user_guide/constants/index.md new file mode 100644 index 000000000..58e196679 --- /dev/null +++ b/documentation/docs/user_guide/constants/index.md @@ -0,0 +1,16 @@ +# CABLE constants + +Table 1 lists the various types of constants used in CABLE. A list of the numerical values of each type can be accessed through the left navigation bar. + + +## Table 1: Various constants used in CABLE + +| CABLE constants | +|------------------------| +| Physical constants | +| Mathematical constants | +| | +| | +| | +| | +| | diff --git a/documentation/docs/user_guide/constants/mathematical_constants.md b/documentation/docs/user_guide/constants/mathematical_constants.md new file mode 100644 index 000000000..dc3e97b38 --- /dev/null +++ b/documentation/docs/user_guide/constants/mathematical_constants.md @@ -0,0 +1,5 @@ +## Table 1: CABLE mathematical constants + +| Name | Value | +|-----------------------|------------------| +| pi | 3.1415927 | diff --git a/documentation/docs/user_guide/constants/physical_constants.md b/documentation/docs/user_guide/constants/physical_constants.md new file mode 100644 index 000000000..b4344b993 --- /dev/null +++ b/documentation/docs/user_guide/constants/physical_constants.md @@ -0,0 +1,23 @@ +## Table 1: CABLE physical constants + +| Name | Value | Units | Description | +|-----------------------|------------------|-----------------------------------------------------|-------------------------------------------------- | +| tfrz | 273.16 | \( K \) | Temperature corresponding to \( 0^{\circ}C \) | +| sboltz | 5.67E-8 | \( W \cdot m^{-2} \cdot K^{-4} \) | Stefan-Boltzmann constant | +| emsoil | 1.0 | \( - \) | Soil emissivity | +| emleaf | 1.0 | \( - \) | Leaf emissivity | +| capp | 1004.64 | \( J \cdot kg^{-1} \cdot K^{-1} \) | Air specific heat | +| hl | 2.5014E6 | \( J \cdot kg^{-1} \) | Latent heat of vaporization | +| hlf | 0.334E6 | \( J \cdot kg^{-1} \) | Latent heat of fusion | +| hls | 2.8350E6 | \( J \cdot kg^{-1} \) | Latent heat of Sublimation | +| dheat | 21.5E-6 | \( cm^{2} \cdot s^{-1} \) | Molecular diffusivity for heat | +| grav | 9.8086 | \( m \cdot s^{-2} \) | Gravity acceleration | +| rgas | 8.3143 | \(J \cdot mol^{-1} \cdot K^{-1} \) | Universal gas const | +| rmair | 0.02897 | \( kg \cdot mol^{-1} \) | Molecular weight of dry air | +| rmh2o | 0.018016 | \( kg \cdot mol^{-1} \) | Molecular weight of water | +| cgsnow | 2090.0 | \( J \cdot kg^{-1} \cdot K^{-1} \) | Specific heat for snow | +| csice | 2.100E3 | \( J \cdot kg^{-1} \cdot K^{-1} \) | Specific heat for ice | +| cswat | 4.218E3 | \( J \cdot kg^{-1} \cdot K^{-1} \) | Specific heat for water at \( 0^{\circ}C \) | +| density_liq | 1000.0 | \( kg \cdot m^{-3} \) | Density of liquid water | +| density_ice | 921.0 | \( kg \cdot m^{-3} \) | Density of ice | + diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml index a9110f262..f310fbc89 100644 --- a/documentation/mkdocs.yml +++ b/documentation/mkdocs.yml @@ -86,6 +86,10 @@ nav: - Restart: user_guide/inputs/restart.md - Output files: - user_guide/outputs/index.md + - CABLE constants: + - user_guide/constants/index.md + - Physical constants: user_guide/constants/physical_constants.md + - Mathematical constants: user_guide/constants/mathematical_constants.md - Other resources: - Existing configurations: user_guide/other_resources/configurations/config.md - Obsolete and deprecated features: user_guide/other_resources/obsolete_and_deprecated_features/obsolete_and_deprecated_features.md diff --git a/src/params/cable_phys_constants_mod.F90 b/src/params/cable_phys_constants_mod.F90 index f0328a6d7..09138981b 100644 --- a/src/params/cable_phys_constants_mod.F90 +++ b/src/params/cable_phys_constants_mod.F90 @@ -25,23 +25,23 @@ MODULE cable_phys_constants_mod REAL, PARAMETER :: sboltz = 5.67e-8 ! Stefan-Boltz. const (W/m2/K4) REAL, PARAMETER :: emsoil = 1.0 ! soil emissivity REAL, PARAMETER :: emleaf = 1.0 ! leaf emissivity -REAL, PARAMETER :: capp = 1004.64 ! air spec. heat (J/kg/K) -REAL, PARAMETER :: hl = 2.5014e6 ! latent heat of vaporization (J/s/m2) +REAL, PARAMETER :: capp = 1004.64 ! air spec. heat (J/kg/K) +REAL, PARAMETER :: hl = 2.5014e6 ! latent heat of vaporization (J/kg) !Below are constants used in CABLE model which are not as yet used in JAC-6.2 -REAL, PARAMETER :: hlf = 0.334e6 ! latent heat of fusion -REAL, PARAMETER :: hls = 2.8350e6 ! latent heatOFsublimation (J/kg) -REAL, PARAMETER :: dheat = 21.5e-6 ! molecular diffusivity for heat +REAL, PARAMETER :: hlf = 0.334e6 ! latent heat of fusion (J/kg) +REAL, PARAMETER :: hls = 2.8350e6 ! latent heat of sublimation (J/kg) +REAL, PARAMETER :: dheat = 21.5e-6 ! molecular diffusivity for heat (cm2/s) REAL, PARAMETER :: grav = 9.8086 ! gravity acceleration (m/s2) -REAL, PARAMETER :: rgas = 8.3143 ! universal gas const (J/mol/K) +REAL, PARAMETER :: rgas = 8.3143 ! universal gas const (J/mol/K) REAL, PARAMETER :: rmair = 0.02897 ! molecular wt: dry air (kg/mol) REAL, PARAMETER :: rmh2o = 0.018016 ! molecular wt: water (kg/mol) REAL, PARAMETER :: cgsnow = 2090.0 ! specific heat for snow (J/kg/K) -REAL, PARAMETER :: cs_rho_ice = 1.9341e6 !heat capacity * density ice +REAL, PARAMETER :: cs_rho_ice = 1.9341e6 ! heat capacity * density ice REAL, PARAMETER :: cs_rho_wat = 4.218e6 ! heat capacity * density water REAL, PARAMETER :: csice = 2.100e3 ! specific heat for ice (J/kg/K) REAL, PARAMETER :: cswat = 4.218e3 ! specific heat for water at 0°C (J/kg/K) REAL, PARAMETER :: density_liq = 1000.0 ! density of liquid water -REAL, PARAMETER :: density_ice = 921.0 ! denisty of ice +REAL, PARAMETER :: density_ice = 921.0 ! density of ice ! Teten coefficients REAL, PARAMETER :: tetena = 6.106 ! Magnus Tetans (Murray 1967) From 5553fc626e8a30b7545a87003e5486ec1c1da315 Mon Sep 17 00:00:00 2001 From: rkutteh <98803952+rkutteh@users.noreply.github.com> Date: Tue, 2 Jul 2024 19:52:26 +1000 Subject: [PATCH 2/2] Update documentation/docs/user_guide/constants/index.md Co-authored-by: Claire Carouge --- documentation/docs/user_guide/constants/index.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/documentation/docs/user_guide/constants/index.md b/documentation/docs/user_guide/constants/index.md index 58e196679..89f8b7e4f 100644 --- a/documentation/docs/user_guide/constants/index.md +++ b/documentation/docs/user_guide/constants/index.md @@ -9,8 +9,3 @@ Table 1 lists the various types of constants used in CABLE. A list of the numeri |------------------------| | Physical constants | | Mathematical constants | -| | -| | -| | -| | -| |