Skip to content

User configurability of switches in CMake #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
anton-seaice wants to merge 6 commits into
base: dev/2025.08
Choose a base branch
from
Draft

User configurability of switches in CMake #12

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
975adb5
Experiments with configuring switches
anton-seaice Feb 4, 2026
221633d
better var names
anton-seaice Feb 4, 2026
3183e1b
better var names
anton-seaice Feb 4, 2026
950784c
better var names
anton-seaice Feb 4, 2026
a307228
better var names
anton-seaice Feb 4, 2026
cc9735e
better var names
anton-seaice Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 51 additions & 8 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,53 @@ project(WW3
# Options #
#]==============================================================================]

## List of switches
# to-do: make configurable
list(APPEND switches "CESMCOUPLED" "DIST" "MPI" "PR1" "FLX4" "ST6" "STAB0" "LN1" "NL1" "BT1" "DB1" "MLIM" "TR0" "BS0" "RWND" "WNX1" "WNT0" "CRX1" "CRT0" "O0" "O1" "O2" "O3" "O4" "O5" "O6" "O7" "O14" "O15" "IS0" "REF0" "NOGRB" "IC4")
## Configuration switches

set(WW3_USER_SWITCHES)
list(APPEND WW3_SWITCHES "${${WW3_USER_SWITCHES}}")

# Check if a switch has been set for each scheme, otherwise set a default
# We don't check that WW3_USER_SWITCHES are valid
foreach(_pair IN ITEMS
#prefix; default value
"PR;PR1" # Propogation scheme
"FLX;FLX4" # Flux computation
"LN;LN1" # Linear Input
Copy link
Collaborator Author

@anton-seaice anton-seaice Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"LN;LN1" # Linear Input
"LN|SEED;LN1" # Linear Input

(or however it works in regex)

Selection of linear input:
ln0 No linear input.
seed Spectral seeding of Eq. (3.70).
ln1 Cavaleri and Malanotte-Rizzoli with filter.
lnx Experimental (user supplied).

"ST;ST6" # input and dissipation
"ST;STAB0" # input and dissipation
"NL;NL1" # nonlinear interactions
"BT;BT1" # bottom friction
"IC;IC4" # damping by sea ice
"IS;IS0" # scattering by sea ice
"REF;REF0" # reflection
"DB;DB1" # depth-induced breaking
"TR;TR0" # triad interactions
"BS;BS0" # bottom scattering
"WNT;WNT0" # wind interpolation (time)
"WNX;WNX1" # wind interpolation (space))
"CRT;CRT0" # current interpolation (time)
"CRX;CRX1" # current interpolation (space)
)
list(GET _pair 0 _prefix)
list(GET _pair 1 _default)

set(_tmp "${WW3_USER_SWITCHES}")
list(FILTER _tmp INCLUDE REGEX "^${_prefix}.")
if(_tmp STREQUAL "")
list(APPEND WW3_SWITCHES "${_default}")
endif()
endforeach()

# Infrastructure switches, unlikely to change
list(APPEND WW3_SWITCHES "${UserSwitches}" "CESMCOUPLED" "DIST" "MPI" "NOGRB")
Copy link
Collaborator Author

@anton-seaice anton-seaice Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
list(APPEND WW3_SWITCHES "${UserSwitches}" "CESMCOUPLED" "DIST" "MPI" "NOGRB")
list(APPEND WW3_SWITCHES "CESMCOUPLED" "DIST" "MPI" "NOGRB")

# output
list(APPEND WW3_SWITCHES "O0" "O1" "O2" "O3" "O4" "O5" "O6" "O7" "O14" "O15")

# miscellaneous
list(APPEND WW3_SWITCHES "MLIM" "RWND" )

message(WW3_SWITCHES "${WW3_SWITCHES}")


option(WW3_ACCESS3 "Use ACCESS3 dependencies and install ACCESS3 libraries" OFF)
option(WW3_OPENMP "Enable OpenMP threading" OFF)
Expand All @@ -29,11 +73,10 @@ if(NOT WW3_ACCESS3)
endif()

if(WW3_OPENMP)
list(APPEND switches "OMPG")
list(APPEND WW3_SWITCHES "OMPG")
endif()



#[==============================================================================[
# Project configuration #
#]==============================================================================]
Expand Down Expand Up @@ -73,11 +116,11 @@ else()
endif()

## Global compile definitions
foreach(switch ${switches})
foreach(switch ${WW3_SWITCHES})
add_compile_definitions(W3_${switch})
endforeach()

if ("CESMCOUPLED" IN_LIST switches)
if ("CESMCOUPLED" IN_LIST WW3_SWITCHES)
add_compile_definitions(CESMCOUPLED)
endif()

Expand Down Expand Up @@ -139,7 +182,7 @@ endif()

# Process switches and get list of extra source files
include(${CMAKE_CURRENT_SOURCE_DIR}/model/src/cmake/check_switches.cmake)
check_switches("${switches}" switch_files)
check_switches("${WW3_SWITCHES}" switch_files)
message(VERBOSE "WW3 switch files: ${switch_files}")

include(${CMAKE_CURRENT_SOURCE_DIR}/model/src/cmake/src_list.cmake)
Expand Down