Add calculation of solar zenith angle and Earth–Sun distance #337

mattldawson · 2024-12-13T16:46:20Z

Tag name (required for release branches):
Originator(s): Matt Dawson

Description (include the issue title, and the keyword ['closes', 'fixes', 'resolves'] followed by the issue number):

Adds the calculation of solar zenith angle and Earth–Sun distance and makes them available as CCPP standard named variables.

@nusbaume - I wasn't sure if I put the call to recalculate the orbital properties is correct. If it isn't let me know, and I can move it.

closes #328
Additionally:

adds some stubbed-out dependencies needed for MUSICA, until the actual values are available from other physics schemes or the host model
adds some testing infrastructure needed for unit tests of this code. Once Initial pFUnit Integration #326 is merged in, I can update this PR to use the new unit testing infrastructure

In draft until ESCOMP/atmospheric_physics#171 is merged in

Describe any changes made to build system:
none

Describe any changes made to the namelist:
none

List any changes to the defaults for the input datasets (e.g. boundary datasets):
none

List all files eliminated and why:
none

List all files added and what they do:

List all existing files that have been modified, and describe the changes:
(Helpful git command: git diff --name-status development...<your_branch_name>)

If there are new failures (compared to the test/existing-test-failures.txt file),
have them OK'd by the gatekeeper, note them here, and add them to the file.
If there are baseline differences, include the test and the reason for the
diff. What is the nature of the change? Roundoff?

derecho/intel/aux_sima:

derecho/gnu/aux_sima:

If this changes climate describe any run(s) done to evaluate the new
climate in enough detail that it(they) could be reproduced:

CAM-SIMA date used for the baseline comparison tests if different than latest:

MPAS dynamical core can now integrate the dynamical states with time.

This functionality is intended for use by dynamics-physics coupling.

This helper function reverses the order of elements in a 1-d array.

This makes the assignments less error-prone and much more intuitive.

This subroutine provides a streamlined mechanism for exchanging constituent states between CAM-SIMA and MPAS.

Use the new `dyn_exchange_constituent_state` subroutine to perform default initialization for all constituents instead.

This assumption does not always hold.

@nusbaume

Adds the calculation of solar zenith angle and Earth-Sun distance needed as inputs to TUV-x. closes #163 closes #164 Both calculations required functions that are currently in shared code in CAM [here](https://github.com/ESCOMP/CESM_share/blob/f6f31fd61cb8f80aee97311fcca64b3e26b0202c/src/shr_orb_mod.F90#L736-L814) and [here](https://github.com/ESCOMP/CESM_share/blob/f6f31fd61cb8f80aee97311fcca64b3e26b0202c/src/shr_orb_mod.F90#L110-L159) that I put in a modified form in the `to_be_ccppized/` folder. @nusbaume @peverwhee - if there is a better way to handle these functions, let me know and I can update the PR. Requires an update to CAM-SIMA that is in review to make certain variables available through CCPP (ESCOMP/CAM-SIMA#325) After more discussion, the plan is to use the shared functions in CAM-SIMA and pass the outputs through CCPP. So, this PR will be put in draft until this issue is finished: ESCOMP/CAM-SIMA#328 A related draft PR to CAM-SIMA has been added (ESCOMP/CAM-SIMA#337) and will be un-drafted once this PR is merged in.

jimmielin

Thanks @mattldawson! Looks good to me, I have one request regarding allocate calls to be consistent with rest of SIMA code and just minor comments on the comments to clarify the purpose of musica_ccpp_dependencies.F90.

jimmielin · 2024-12-16T15:33:59Z

src/physics/utils/orbital_data.F90

+
+    integer, intent(in) :: number_of_columns
+
+    allocate(solar_zenith_angle(number_of_columns), source=FILL_R8)


For these allocate calls (and elsewhere) could check_allocate (from cam_abortutils) be added after those as well?

I think they are all updated now. Let me know if I missed any.

jimmielin · 2024-12-16T15:38:05Z

src/physics/utils/musica_ccpp_dependencies.F90

+    allocate(blackbody_temperature_at_surface(horizontal_dimension))
+    allocate(cloud_area_fraction(horizontal_dimension, vertical_layer_dimension))
+
+    surface_albedo(:) = 0.1_kind_phys


Just to confirm - these appear to be realistic values for a first version of MUSICA in CAM-SIMA, while the necessary physical quantities are not fully available yet. Is this correct?

Just to make sure since if "realistic" values are provided here at initialization it might be difficult to debug later when something's supposed to be provided from a physical scheme and the values are not as expected. But if this is a placeholder then it is fine!

It is just a placeholder, but I tried to add more text to the comments describing this module to make clear that it should be entirely removed once the things that actually provide this information are in place, and before doing any real science. Let me know if it's more clear now, or if we should add anything else.

jimmielin · 2024-12-16T15:40:27Z

src/control/cam_comp.F90

@@ -253,6 +255,14 @@ subroutine cam_init(caseid, ctitle, model_doi_url,                         &
      ! end if
      call history_init_files(model_doi_url, caseid, ctitle)

+      ! Temporary:  Initialize MUSICA dependencies


Purely a comment nitpick - Can I ask if the comment could be made clearer here? "dependencies" is a generic term and I thought this was initializing external libraries, etc. Maybe it could be described as prescribing physical quantities necessary for MUSICA that are currently unavailable in SIMA? Something like that would make it clear that it's assigning placeholder values for an early version of MUSICA.

I updated the comment to use your suggested text.

nusbaume

Thanks for getting this brought in @mattldawson! I just have a few change requests (but if any cause problems please let me know). Thanks!

src/control/cam_comp.F90

src/physics/utils/musica_ccpp_dependencies.meta

src/physics/utils/orbital_data.F90

src/physics/utils/orbital_data.meta

test/unit/physics/utils/test_orbital_data_stubs.F90

src/physics/utils/orbital_data.F90

src/physics/utils/musica_ccpp_dependencies.F90

boulderdaze

Looks good to me! I don't have any comments except for the ones others have mentioned

jimmielin

Thanks for addressing my comments @mattldawson!

nusbaume

Everything looks good to me now, thanks @mattldawson!

peverwhee

one tiny note - thanks @mattldawson

peverwhee · 2024-12-16T22:27:43Z

src/physics/utils/orbital_data.meta

+  type = module
+[solar_declination]
+  standard_name = solar_declination
+  units = radians


in keeping with the SI units we (recently) decided on, this (and solar_zenith_angle) should be "rad".

if you want to just include this update in your existing PR - ESCOMP/atmospheric_physics#181 that would be swell.

mattldawson and others added 30 commits December 10, 2024 14:24

and orbital data module

6b6262c

draft updates to call orbital data functions during simulation

6a78028

update musica dependency modules

85507a5

update MUSICA dependencies

64972ba

merge development into develop-328-orbital-properties

c5b59b2

Sort use statements and adjust indentation

1503ca4

Implement MPAS subdriver

0374d8d

MPAS dynamical core can now integrate the dynamical states with time.

Support for computing edge wind tendency in MPAS subdriver

01af24b

This functionality is intended for use by dynamics-physics coupling.

Implement dyn_run

7a06bcb

Wire up dyn_run

eb3792f

Sort use statements and add comments

22c26d5

Factor out variable finalization

3c4faa5

Implement reverse

0e3a2d1

This helper function reverses the order of elements in a 1-d array.

Refactor assignments between CAM-SIMA and MPAS in terms of reverse

7e34e0c

This makes the assignments less error-prone and much more intuitive.

Implement dyn_exchange_constituent_state

eb81389

This subroutine provides a streamlined mechanism for exchanging constituent states between CAM-SIMA and MPAS.

Switch to use dyn_exchange_constituent_state

d6fc775

Use the new `dyn_exchange_constituent_state` subroutine to perform default initialization for all constituents instead.

Implement dynamics-physics coupling and vice versa

9b81368

Wire up dynamics-physics coupling

c6d65bd

Add more detailed comments about an MPAS subroutine

ffded6e

Fix grammar in comments

f58a958

Only call reverse once per cell when performing conversion

4f1fe50

Pass arguments by keywords for better clarity

4de2299

Rename internal subroutines

cf1e015

Include error codes and messages returned by external procedures

19ff182

Just use equation of state

ac8fbe0

Do not assume no water at top of model

0a7d866

This assumption does not always hold.

Add more detailed comments about equation derivation

47c41ba

add function argument

1472273

merge development into develop-328-optical-properties

3c153f5

update dockerfile

1ceba5a

mattldawson mentioned this pull request Dec 13, 2024

Solar zenith angle and Earth-Sun distance ESCOMP/atmospheric_physics#171

Merged

use photons in units

b473122

mattldawson requested review from nusbaume, jimmielin, peverwhee and boulderdaze December 14, 2024 00:23

mattldawson marked this pull request as ready for review December 14, 2024 00:25

jimmielin requested changes Dec 16, 2024

View reviewed changes

nusbaume requested changes Dec 16, 2024

View reviewed changes

nusbaume reviewed Dec 16, 2024

View reviewed changes

src/physics/utils/orbital_data.F90 Outdated Show resolved Hide resolved

boulderdaze reviewed Dec 16, 2024

View reviewed changes

src/physics/utils/musica_ccpp_dependencies.F90 Outdated Show resolved Hide resolved

boulderdaze approved these changes Dec 16, 2024

View reviewed changes

address reviewer comments

afee2af

jimmielin approved these changes Dec 16, 2024

View reviewed changes

address reviewer comments

253a5eb

mattldawson requested a review from nusbaume December 16, 2024 18:52

nusbaume approved these changes Dec 16, 2024

View reviewed changes

peverwhee approved these changes Dec 16, 2024

View reviewed changes

mattldawson added 4 commits December 17, 2024 13:35

update atmopsheric physics

da5891c

Merge branch 'development' into develop-328-orbital-properties

252cdb1

update atmos phys commit and change radians to rad

404e8e4

ignore vscode files

be4ee44

mattldawson merged commit 87f6fad into ESCOMP:development Dec 31, 2024
8 checks passed

mattldawson deleted the develop-328-orbital-properties branch December 31, 2024 19:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add calculation of solar zenith angle and Earth–Sun distance #337

Add calculation of solar zenith angle and Earth–Sun distance #337

mattldawson commented Dec 13, 2024 •

edited

Loading

jimmielin left a comment

jimmielin Dec 16, 2024

mattldawson Dec 16, 2024

jimmielin Dec 16, 2024

mattldawson Dec 16, 2024

jimmielin Dec 16, 2024

mattldawson Dec 16, 2024

nusbaume left a comment

boulderdaze left a comment

jimmielin left a comment

nusbaume left a comment

peverwhee left a comment

peverwhee Dec 16, 2024

mattldawson Dec 16, 2024


		integer, intent(in) :: number_of_columns

		allocate(solar_zenith_angle(number_of_columns), source=FILL_R8)

Add calculation of solar zenith angle and Earth–Sun distance #337

Add calculation of solar zenith angle and Earth–Sun distance #337

Conversation

mattldawson commented Dec 13, 2024 • edited Loading

jimmielin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nusbaume left a comment

Choose a reason for hiding this comment

boulderdaze left a comment

Choose a reason for hiding this comment

jimmielin left a comment

Choose a reason for hiding this comment

nusbaume left a comment

Choose a reason for hiding this comment

peverwhee left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattldawson commented Dec 13, 2024 •

edited

Loading