# git $Id$
# svn $Id: makefile 1184 2023-07-27 20:28:19Z arango $
#::::::::::::::::::::::::::::::::::::::::::::::::::::: Hernan G. Arango :::
# Copyright (c) 2002-2023 The ROMS/TOMS Group Kate Hedstrom :::
# Licensed under a MIT/X style license :::
# See License_ROMS.md :::
#::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
# :::
# ROMS/TOMS Framework Master Makefile :::
# :::
# This makefile is designed to work only with GNU Make version 3.80 or :::
# higher. It can be used in any architecture provided that there is a :::
# machine/compiler rules file in the "Compilers" subdirectory. You :::
# may need to modify the rules file to specify the correct path for :::
# the NetCDF and ARPACK libraries. The ARPACK library is only used in :::
# the Generalized Stability Theory analysis and Laczos algorithm. :::
# :::
# If appropriate, the USER needs to modify the macro definitions in :::
# in user-defined section below. To activate an option set the macro :::
# to "on". For example, if you want to compile with debugging options :::
# set: :::
# :::
# USE_DEBUG := on :::
# :::
# Otherwise, leave macro definition blank. :::
# :::
# The USER needs to provide a value for the macro FORT. Choose the :::
# appropriate value from the list below. :::
# :::
#::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
ifneq (3.80,$(firstword $(sort $(MAKE_VERSION) 3.80)))
$(error This makefile requires GNU make version 3.80 or higher. \
Your current version is: $(MAKE_VERSION))
endif
#--------------------------------------------------------------------------
# Initialize some things.
#--------------------------------------------------------------------------
sources :=
#--------------------------------------------------------------------------
# Check that at least one of SHARED, STATIC, or EXEC are set. If none are
# set, then ROMS defaults to creating a statically linked executable.
# This is to safeguard against old build scripts and misconfigured
# new ones (e.g. EXEC defined but neither SHARED nor STATIC defined).
#--------------------------------------------------------------------------
ifndef SHARED
ifndef STATIC
STATIC := on
ifndef EXEC
EXEC := on
endif
endif
endif
#==========================================================================
# Start of user-defined options. In some macro definitions below: "on" or
# any other string means TRUE while blank (or spaces) is FALSE.
#==========================================================================
#
# The CPP option defining a particular application is specified below.
# See header file "ROMS/Include/cppdefs.h" for all available idealized
# and realistic applications CPP flags. For example, to activate the
# upwelling test case (UPWELLING) set:
#
# ROMS_APPLICATION ?= UPWELLING
#
# Notice that this makefile will include the associated application header
# file, which is located either in the "ROMS/Include" or MY_HEADER_DIR
# directory. This makefile is designed to search in both directories.
# The only constrain is that the application CPP option must be unique
# and header file name is the lowercase value of ROMS_APPLICATION with
# the .h extension. For example, the upwelling application includes the
# "upwelling.h" header file.
ROMS_APPLICATION ?= UPWELLING
# If application header files is not located in "ROMS/Include",
# provide an alternate directory FULL PATH.
MY_HEADER_DIR ?=
# If your application requires analytical expressions and they are
# not located in "ROMS/Functionals", provide an alternate directory.
# Notice that a set analytical expressions templates can be found in
# "User/Functionals".
#
# If applicable, also used this directory to place your customized
# biology model header file (like fennel.h, nemuro.h, ecosim.h, etc).
MY_ANALYTICAL_DIR ?=
# Sometimes it is desirable to activate one or more CPP options to
# run different variants of the same application without modifying
# its header file. If this is the case, specify such options here
# using the -D syntax. For example, to write time-averaged fields
# set:
#
# MY_CPP_FLAGS ?= -DAVERAGES
#
MY_CPP_FLAGS ?=
# Activate debugging compiler options:
USE_DEBUG ?=
# If parallel applications, use at most one of these definitions
# (leave both definitions blank in serial applications):
USE_MPI ?=
USE_OpenMP ?=
# If distributed-memory, turn on compilation via the script "mpif90".
# This is needed in some Linux operating systems. In some systems with
# native MPI libraries the compilation does not require MPICH type
# scripts. This macro is also convient when there are several fortran
# compiliers (ifort, pgf90, pathf90) in the system that use mpif90.
# In this, case the user need to select the desired compiler below and
# turn on both USE_MPI and USE_MPIF90 macros.
USE_MPIF90 ?=
# If applicable, activate 64-bit compilation:
USE_LARGE ?= on
# If applicable, link with NetCDF-4 library. Notice that the NetCDF-4
# library needs both the HDF5 and MPI libraries.
USE_NETCDF4 ?=
#--------------------------------------------------------------------------
# We are going to include a file with all the settings that depend on
# the system and the compiler. We are going to build up the name of the
# include file using information on both. Set your compiler here from
# the following list:
#
# Operating System Compiler(s)
#
# AIX: xlf
# ALPHA: f90
# CYGWIN: g95, df, ifort
# Darwin: f90, xlf
# IRIX: f90
# Linux: ftn, ifc, ifort, pgi, path, g95, gfortran
# SunOS: f95
# UNICOS-mp: ftn
# SunOS/Linux: ftn (Cray cross-compiler)
#
# Feel free to send us additional rule files to include! Also, be sure
# to check the appropriate file to make sure it has the right paths to
# NetCDF and so on.
#--------------------------------------------------------------------------
FORT ?= pgi
#--------------------------------------------------------------------------
# Set directory for executable.
#--------------------------------------------------------------------------
BINDIR ?= .
#==========================================================================
# End of user-defined options. See also the machine-dependent include
# file being used above.
#==========================================================================
#--------------------------------------------------------------------------
# Set ROMS Build directory for processing and compiling files.
#--------------------------------------------------------------------------
BUILD_DIR ?= Build_roms
# Backward compatability with old build scripts and make configuration
# files (*.mk). The BUILD_DIR macro is preferred.
ifdef SCRATCH_DIR
BUILD_DIR := $(SCRATCH_DIR)
else
SCRATCH_DIR := $(BUILD_DIR)
endif
# Define cleaning macros for compiling.
clean_list := core *.ipo $(BUILD_DIR)
ifeq "$(strip $(BUILD_DIR))" "."
clean_list := core *.o *.oo *.mod *.f90 lib*.a *.bak
clean_list += $(CURDIR)/*.ipo
endif
ifeq "$(strip $(BUILD_DIR))" "./"
clean_list := core *.o *.oo *.ipo *.mod *.f90 lib*.a *.bak
clean_list += $(CURDIR)/*.ipo
endif
#--------------------------------------------------------------------------
# Notice that the token "libraries" is initialized with the ROMS/Utility
# library to account for calls to objects in other ROMS libraries or
# cycling dependencies. These types of dependencies are problematic in
# some compilers during linking. Such libraries appear twice at linking
# step (beginning and almost the end of ROMS library list).
#--------------------------------------------------------------------------
libraries :=
#--------------------------------------------------------------------------
# Set Pattern rules.
#--------------------------------------------------------------------------
%.o: %.F
%.o: %.f90
cd $(BUILD_DIR); $(FC) -c $(FFLAGS) $(notdir $<)
%.f90: %.F
$(CPP) $(CPPFLAGS) $(MY_CPP_FLAGS) $< > $*.f90
$(CLEAN) $*.f90
CLEAN := ROMS/Bin/cpp_clean
#--------------------------------------------------------------------------
# Set C-preprocessing flags associated with ROMS application. They are
# used in "ROMS/Include/cppdefs.h" to include the appropriate application
# header file.
#--------------------------------------------------------------------------
ifdef ROMS_APPLICATION
HEADER := $(addsuffix .h, \
$(shell echo ${ROMS_APPLICATION} | tr [A-Z] [a-z]))
ROMS_CPPFLAGS := -D$(ROMS_APPLICATION)
ROMS_CPPFLAGS += -D'HEADER="$(HEADER)"'
ifdef MY_HEADER_DIR
ROMS_CPPFLAGS += -D'ROMS_HEADER="$(MY_HEADER_DIR)/$(HEADER)"'
else
ROMS_CPPFLAGS += -D'ROMS_HEADER="$(HEADER)"'
endif
ifdef MY_CPP_FLAGS
ROMS_CPPFLAGS += $(MY_CPP_FLAGS)
endif
endif
#--------------------------------------------------------------------------
# Internal macro definitions used to select the code to compile and
# additional libraries to link. It uses the CPP activated in the
# header file ROMS/Include/cppdefs.h to determine macro definitions.
#--------------------------------------------------------------------------
COMPILERS ?= $(CURDIR)/Compilers
MAKE_MACROS := $(shell echo ${HOME} | sed 's| |\\ |g')/make_macros.mk
ifneq ($(MAKECMDGOALS),clean)
ifneq ($(MAKECMDGOALS),tarfile)
MACROS := $(shell cpp -P $(ROMS_CPPFLAGS) Compilers/make_macros.h > \
$(MAKE_MACROS); $(CLEAN) $(MAKE_MACROS))
GET_MACROS := $(wildcard $(BUILD_DIR)/make_macros.*)
ifdef GET_MACROS
include $(BUILD_DIR)/make_macros.mk
else
include $(MAKE_MACROS)
endif
endif
endif
clean_list += $(MAKE_MACROS)
#--------------------------------------------------------------------------
# Make functions for putting the temporary files in $(BUILD_DIR)
# DO NOT modify this section; spaces and blank lines are needed.
#--------------------------------------------------------------------------
# $(call source-dir-to-binary-dir, directory-list)
source-dir-to-binary-dir = $(addprefix $(BUILD_DIR)/, $(notdir $1))
# $(call source-to-object, source-file-list)
source-to-object = $(call source-dir-to-binary-dir, \
$(subst .F,.o,$1))
# $(call make-static-library, library-name, source-file-list)
define make-static-library
sources += $2
$(BUILD_DIR)/$1: $(call source-dir-to-binary-dir, \
$(subst .F,.o,$2))
$(AR) $(ARFLAGS) $$@ $$^
$(RANLIB) $$@
endef
# $(call make-shared-library, library-name, source-file-list)
define make-shared-library
$(BUILD_DIR)/$1: $(call source-dir-to-binary-dir, \
$(subst .F,.o,$2))
$(LD) $(FFLAGS) $(SH_LDFLAGS) -o $$@ $$^ $(LIBS)
endef
# $(call f90-source, source-file-list)
f90-source = $(call source-dir-to-binary-dir, \
$(subst .F,.f90,$1))
# $(compile-rules)
define compile-rules
$(foreach f, $(local_src), \
$(call one-compile-rule,$(call source-to-object,$f), \
$(call f90-source,$f),$f))
endef
# $(call one-compile-rule, binary-file, f90-file, source-files)
define one-compile-rule
$1: $2 $3
cd $$(BUILD_DIR); $$(FC) -c $$(FFLAGS) $(notdir $2)
$2: $3
$$(CPP) $$(CPPFLAGS) $$(MY_CPP_FLAGS) $$< > $$@
$$(CLEAN) $$@
endef
#--------------------------------------------------------------------------
# Set ROMS/TOMS executable file name.
#--------------------------------------------------------------------------
ifdef EXEC
ifdef USE_DEBUG
BIN ?= $(BINDIR)/romsG
else
ifdef USE_MPI
BIN ?= $(BINDIR)/romsM
else
ifdef USE_OpenMP
BIN ?= $(BINDIR)/romsO
else
BIN ?= $(BINDIR)/romsS
endif
endif
endif
endif
#--------------------------------------------------------------------------
# Set name of module files for netCDF F90 interface. On some platforms
# these will need to be overridden in the machine-dependent include file.
#--------------------------------------------------------------------------
NETCDF_MODFILE := netcdf.mod
TYPESIZES_MODFILE := typesizes.mod
#--------------------------------------------------------------------------
# "uname -s" should return the OS or kernel name and "uname -m" should
# return the CPU or hardware name. In practice the results can be pretty
# flaky. Run the results through sed to convert "/" and " " to "-",
# then apply platform-specific conversions.
#--------------------------------------------------------------------------
OS := $(shell uname -s | sed 's/[\/ ]/-/g')
OS := $(patsubst CYGWIN_%,CYGWIN,$(OS))
OS := $(patsubst MINGW%,MINGW,$(OS))
OS := $(patsubst sn%,UNICOS-sn,$(OS))
CPU := $(shell uname -m | sed 's/[\/ ]/-/g')
GITURL := $(shell git config remote.origin.url)
GITREV := $(shell git log -n 1 --format=%H)
SVNURL := $(shell grep HeadURL ./ROMS/Version | \
sed 's/.* \(https.*\)\/ROMS\/Version.*/\1/')
SVNREV := $(shell grep Revision ./ROMS/Version | \
sed 's/.* \([0-9]*\) .*/\1/')
ROOTDIR := $(shell pwd)
ifndef FORT
$(error Variable FORT not set)
endif
ifneq ($(MAKECMDGOALS),clean)
ifneq ($(MAKECMDGOALS),tarfile)
MKFILE := $(COMPILERS)/$(OS)-$(strip $(FORT)).mk
include $(MKFILE)
endif
endif
ifdef USE_MPI
ifdef USE_OpenMP
$(error You cannot activate USE_MPI and USE_OpenMP at the same time!)
endif
endif
ifdef STATIC
libraries += $(BUILD_DIR)/$(ST_LIB_NAME)
endif
ifdef SHARED
libraries += $(BUILD_DIR)/$(SH_LIB_NAME)
endif
#--------------------------------------------------------------------------
# Pass the platform variables to the preprocessor as macros. Convert to
# valid, upper-case identifiers. Attach ROMS application CPP options.
#--------------------------------------------------------------------------
CPPFLAGS += -D$(shell echo ${OS} | tr "-" "_" | tr [a-z] [A-Z])
CPPFLAGS += -D$(shell echo ${CPU} | tr "-" "_" | tr [a-z] [A-Z])
CPPFLAGS += -D$(shell echo ${FORT} | tr "-" "_" | tr [a-z] [A-Z])
CPPFLAGS += -D'ROOT_DIR="$(ROOTDIR)"'
ifdef ROMS_APPLICATION
CPPFLAGS += $(ROMS_CPPFLAGS)
CPPFLAGS += -DNestedGrids=$(NestedGrids)
MDEPFLAGS += -DROMS_HEADER="$(HEADER)"
endif
ifndef MY_ANALYTICAL_DIR
MY_ANALYTICAL_DIR := $(ROOTDIR)/ROMS/Functionals
endif
ifeq (,$(findstring ROMS/Functionals,$(MY_ANALYTICAL_DIR)))
MY_ANALYTICAL := on
endif
CPPFLAGS += -D'ANALYTICAL_DIR="$(MY_ANALYTICAL_DIR)"'
ifdef MY_ANALYTICAL
CPPFLAGS += -D'MY_ANALYTICAL="$(MY_ANALYTICAL)"'
endif
CPPFLAGS += -D'GIT_URL="$(GITURL)"'
CPPFLAGS += -D'GIT_REV="$(GITREV)"'
CPPFLAGS += -D'SVN_URL="$(SVNURL)"'
CPPFLAGS += -D'SVN_REV="$(SVNREV)"'
#--------------------------------------------------------------------------
# Build target directories.
#--------------------------------------------------------------------------
.PHONY: all
all: $(BUILD_DIR) $(BUILD_DIR)/MakeDepend $(libraries) $(BIN) rm_macros $(CYG_DLL_CP)
modules :=
ifdef USE_ADJOINT
modules += ROMS/Adjoint \
ROMS/Adjoint/Biology
endif
ifdef USE_REPRESENTER
modules += ROMS/Representer \
ROMS/Representer/Biology
endif
ifdef USE_SEAICE
modules += ROMS/Nonlinear/SeaIce
endif
ifdef USE_TANGENT
modules += ROMS/Tangent \
ROMS/Tangent/Biology
endif
modules += ROMS/Nonlinear \
ROMS/Nonlinear/BBL \
ROMS/Nonlinear/Biology \
ROMS/Nonlinear/Sediment \
ROMS/Functionals \
ROMS/Utility \
ROMS/Drivers \
ROMS/Modules
includes := ROMS/Include
ifdef MY_ANALYTICAL
includes += $(MY_ANALYTICAL_DIR)
endif
ifdef USE_ADJOINT
includes += ROMS/Adjoint \
ROMS/Adjoint/Biology
endif
ifdef USE_REPRESENTER
includes += ROMS/Representer \
ROMS/Representer/Biology
endif
ifdef USE_SEAICE
includes += ROMS/Nonlinear/SeaIce
endif
ifdef USE_TANGENT
includes += ROMS/Tangent \
ROMS/Tangent/Biology
endif
includes += ROMS/Nonlinear \
ROMS/Nonlinear/BBL \
ROMS/Nonlinear/Biology \
ROMS/Nonlinear/Sediment \
ROMS/Utility \
ROMS/Drivers \
ROMS/Functionals
ifdef MY_HEADER_DIR
includes += $(MY_HEADER_DIR)
endif
ifdef USE_PIO
includes += $(PIO_INCDIR)
endif
ifdef USE_COAMPS
includes += $(COAMPS_LIB_DIR)
endif
ifdef USE_WRF
ifeq "$(strip $(WRF_LIB_DIR))" "$(WRF_SRC_DIR)"
includes += $(addprefix $(WRF_LIB_DIR)/,$(WRF_MOD_DIRS))
else
includes += $(WRF_LIB_DIR)
endif
endif
modules += Master
includes += Master Compilers
vpath %.F $(modules)
vpath %.h $(includes)
vpath %.f90 $(BUILD_DIR)
vpath %.o $(BUILD_DIR)
include $(addsuffix /Module.mk,$(modules))
MDEPFLAGS += $(patsubst %,-I %,$(includes)) --silent --moddir $(BUILD_DIR)
CPPFLAGS += $(patsubst %,-I%,$(includes))
ifdef MY_HEADER_DIR
CPPFLAGS += -D'HEADER_DIR="$(MY_HEADER_DIR)"'
else
CPPFLAGS += -D'HEADER_DIR="$(ROOTDIR)/ROMS/Include"'
endif
$(BUILD_DIR):
$(shell $(TEST) -d $(BUILD_DIR) || $(MKDIR) $(BUILD_DIR) )
#--------------------------------------------------------------------------
# Special CPP macros for mod_strings.F
#--------------------------------------------------------------------------
$(BUILD_DIR)/mod_strings.f90: CPPFLAGS += -DMY_OS='"$(OS)"' \
-DMY_CPU='"$(CPU)"' -DMY_FORT='"$(FORT)"' \
-DMY_FC='"$(FC)"' -DMY_FFLAGS='"$(FFLAGS)"'
#--------------------------------------------------------------------------
# ROMS/TOMS libraries.
#--------------------------------------------------------------------------
ifdef SHARED
$(eval $(call make-shared-library,$(SH_LIB_NAME),$(sources)))
endif
ifdef STATIC
$(eval $(call make-static-library,$(ST_LIB_NAME),$(sources)))
endif
MYLIB := libroms.a
.PHONY: libraries
libraries: $(libraries)
#--------------------------------------------------------------------------
# Target to create ROMS/TOMS dependecies.
#--------------------------------------------------------------------------
ifneq ($(MAKECMDGOALS),tarfile)
$(BUILD_DIR)/$(NETCDF_MODFILE): | $(BUILD_DIR)
cp -f $(NETCDF_INCDIR)/$(NETCDF_MODFILE) $(BUILD_DIR)
$(BUILD_DIR)/$(TYPESIZES_MODFILE): | $(BUILD_DIR)
cp -f $(NETCDF_INCDIR)/$(TYPESIZES_MODFILE) $(BUILD_DIR)
$(BUILD_DIR)/MakeDepend: makefile \
$(BUILD_DIR)/$(NETCDF_MODFILE) \
$(BUILD_DIR)/$(TYPESIZES_MODFILE) \
| $(BUILD_DIR)
@ $(SFMAKEDEPEND) $(MDEPFLAGS) $(sources) > $(BUILD_DIR)/MakeDepend
cp -p $(MAKE_MACROS) $(BUILD_DIR)
.PHONY: depend
SFMAKEDEPEND := ./ROMS/Bin/sfmakedepend
depend: $(BUILD_DIR)
$(SFMAKEDEPEND) $(MDEPFLAGS) $(sources) > $(BUILD_DIR)/MakeDepend
endif
ifneq ($(MAKECMDGOALS),clean)
-include $(BUILD_DIR)/MakeDepend
endif
#--------------------------------------------------------------------------
# Target to create ROMS/TOMS tar file.
#--------------------------------------------------------------------------
.PHONY: tarfile
tarfile:
tar --exclude=".svn" -cvf roms-3_7.tar *
.PHONY: zipfile
zipfile:
zip -r roms-3_7.zip *
.PHONY: gzipfile
gzipfile:
gzip -v roms-3_7.gzip *
#--------------------------------------------------------------------------
# Cleaning targets.
#--------------------------------------------------------------------------
.PHONY: clean
clean:
$(RM) -r $(clean_list)
.PHONY: rm_macros
rm_macros:
$(RM) -r $(MAKE_MACROS)
#--------------------------------------------------------------------------
# A handy debugging target. This will allow to print the value of any
# makefile defined macro (see http://tinyurl.com/8ax3j). For example,
# to find the value of CPPFLAGS execute:
#
# gmake print-CPPFLAGS
# or
# make print-CPPFLAGS
#--------------------------------------------------------------------------
.PHONY: print-%
print-%:
@echo $* = $($*)