makefile

# Disable the default rules
MAKEFLAGS += --no-builtin-rules --no-builtin-variables
#
DEBUG := f
DDEBUG := $(subst T,t,$(DEBUG))
#=================================================================================
#=================================================================================
# Compiler?
#Possible values: ifort, ifx, gfortran (default), nagfor 
 FC := gfortran
#FC := ifort
#FC := nagfor
#
# Optimize? Empty: default Optimization; 0: No Optimization; 1 Optimization
OPT := 1
## OpenMP? Empty: default with OpenMP; 0: No OpenMP; 1 with OpenMP
OMP := 1
## Lapack/blas/mkl? Empty: default with Lapack; 0: without Lapack; 1 with Lapack
LAPACK := 1
## force the default integer (without kind) during the compillation.
## default 4: , INT=8 (for kind=8)
INT := 4
## change the real kind
## default real64: , possibilities, real32, real64, real128
RKIND := real64
# For some compilers (like lfortran), real128 (quadruple precision) is not implemented
# WITHRK16 = 1 (0) compilation with (without) real128
WITHRK16 :=
## branch of the external libraries
BRANCH      := main
# how to clean (recursively (1) or not (0)) the external libraries (*_loc)
RECCLEAN    := 1
#=================================================================================
ifeq ($(FC),)
  override FC := gfortran
endif
FFC := $(FC)

ifeq ($(OPT),)
  override OPT := 1
endif
ifneq ($(OPT),$(filter $(OPT),0 1))
  $(info *********** OPT (optimisation):        $(OPT))
  $(info Possible values: 0, 1)
  $(error ERROR: Incompatible option values)
endif
OOPT := $(OPT)

ifeq ($(OMP),)
  override OMP := 1
endif
ifneq ($(OMP),$(filter $(OMP),0 1))
  $(info *********** OMP (openmp):        $(OMP))
  $(info Possible values: 0, 1)
  $(error ERROR: Incompatible option values)
endif
OOMP := $(OMP)

ifeq ($(LAPACK),)
  override LAPACK := 1
endif
ifneq ($(LAPACK),$(filter $(LAPACK),0 1))
  $(info *********** LAPACK:        $(LAPACK))
  $(info Possible values: 0, 1)
  $(error ERROR: Incompatible option values)
endif
LLAPACK := $(LAPACK)

ifneq ($(INT),$(filter $(INT),4 8))
  $(info *********** INT (change default integer):        $(INT))
  $(info Possible values: 4, 8)
  $(error ERROR: Incompatible option values)
endif

ifneq ($(RKIND),$(filter $(RKIND),real32 real64 real128))
  $(info *********** RKIND (select the real kind):        $(RKIND))
  $(info Possible values (case sensitive): real32 real64 real128)
  $(error ERROR: Incompatible option values)
endif
ifeq ($(WITHRK16),)
  override WITHRK16 := $(shell $(FFC) -o scripts/testreal128.exe scripts/testreal128.f90 &> /dev/null ; wait ; ./scripts/testreal128.exe ; rm scripts/testreal128.exe)
endif
WWITHRK16 := $(WITHRK16)
ifneq ($(WITHRK16),$(filter $(WITHRK16),0 1))
  $(info *********** WITHRK16 (compilation with real128):        $(WITHRK16))
  $(info Possible values: 0, 1)
  $(error ERROR: Incompatible option values)
endif
ifeq ($(RKIND),real128)
  ifeq ($(WWITHRK16),0)
    $(info "Incompatible options:")
    $(info ***********RKIND:        $(RKIND))
    $(info ***********WITHRK16:     $(WITHRK16))
    $(error ERROR: Incompatible RKIND and WITHRK16 option values)
  endif
endif
export RKIND WITHRK16 INT  LAPACK  FC  OPT  OMP BRANCH
export      WWITHRK16     LLAPACK FFC OOPT OOMP
#
#=================================================================================
# Operating system, OS? automatic using uname:
#=================================================================================
OS:=$(shell uname)
#=================================================================================
# extension for the library (.a), objects and modules directory
#=================================================================================
ext_obj    :=_$(FC)_opt$(OPT)_omp$(OMP)_lapack$(LAPACK)_int$(INT)_$(RKIND)
extold_obj :=_$(FC)_opt$(OPT)_omp$(OMP)_lapack$(LAPACK)_int$(INT)
#=================================================================================
# Directories
#=================================================================================
MAIN_path    := $(shell pwd)
#
OBJ_DIR      := OBJ/obj$(ext_obj)
OBJOLD_DIR   := OBJ/obj$(extold_obj)
MOD_DIR      := $(OBJ_DIR)
#
SRC_DIR      := SRC
APP_DIR      := APP
TESTS_DIR    := Tests
TESTSOUT_DIR := $(TESTS_DIR)/output

LIB_NAME     := QuantumModelLib

EXTMODEL_DIR := $(MAIN_path)/Ext_Model
#=================================================================================
# Cpreprocessing macros
#=================================================================================
LIB_VERSION=$(shell awk '/version/ {print $$3}' fpm.toml | head -1)
#
CPPSHELL    = -D__COMPILE_DATE="\"$(shell date +"%a %e %b %Y - %H:%M:%S")\"" \
              -D__COMPILE_HOST="\"$(shell hostname -s)\"" \
              -D__QML_VER='$(LIB_VERSION)' \
              -D__QMLPATH="'$(MAIN_path)'" \
              -D__RKIND="$(RKIND)" -D__WITHRK16="$(WITHRK16)" \
              -D__LAPACK="$(LAPACK)"
#=================================================================================
# To deal with external compilers.mk file
#=================================================================================
CompilersDIR = $(MAIN_path)/scripts
ifeq ($(CompilersDIR),)
  include scripts/compilers.mk
else
  include $(CompilersDIR)/compilers.mk
endif
#=================================================================================
# External Model : ExtModel_m.f90
#=================================================================================
# it will create the link
MEL := $(shell readlink  $(MAIN_path)/$(SRC_DIR)/QML/ExtModel_m.f90)
$(info ***********MEL:       $(MEL))
MES := $(shell if ! test -e "$(MEL)" ; then echo "the ExtModel_m.f90 link does not exist or is wrong"; rm -f $(MAIN_path)/$(SRC_DIR)/QML/ExtModel_m.f90; fi)
$(info ***********MES:       $(MES))
MES := $(shell test -L $(MAIN_path)/$(SRC_DIR)/QML/ExtModel_m.f90 || ln -s  $(EXTMODEL_DIR)/ExtModel_m.f90 $(MAIN_path)/$(SRC_DIR)/QML/ExtModel_m.f90)
MES := $(shell if test -L $(MAIN_path)/$(SRC_DIR)/QML/ExtModel_m.f90; then echo "the ExtModel_m.f90 link exists"; else echo "ERR"; fi)
$(info ***********MES:       $(MES))
ifeq ("$(MES)","ERR")
    $(error ERROR: the ExtModel_m.f90 link does not exist)
endif
#=================================================================================
# External Libraries : QDUtilLib AD_dnSVM
#=================================================================================
EXTLIB_LIST := AD_dnSVM QDUtilLib
ifneq ($(EXTLIB_LIST),)
  ifeq ($(ExtLibDIR),)
    ExtLibDIR := $(MAIN_path)/Ext_Lib
  endif
  OK := $(shell if test -d $(ExtLibDIR); then echo "ok"; fi)
  #$(info ***********OK:       $(OK))
  ifeq ($(OK),)
    $(error ERROR: $(ExtLibDIR) does not exist!)
  endif
  export ExtLibDIR

  EXTLib_DIR  := $(addprefix $(ExtLibDIR)/, $(EXTLIB_LIST))
  EXTMod      := $(addsuffix /OBJ/obj$(ext_obj), $(EXTLib_DIR))
  EXTLibOBJ   := $(addsuffix /*.o, $(EXTMod))
  EXTMod      := $(addprefix -I,$(EXTMod))
  #$(info ***********EXTLib_DIR:       $(EXTLib_DIR))
  EXTLib := $(shell for LLIB in $(EXTLIB_LIST) ; do echo $(ExtLibDIR)/$$LLIB"/lib"$$LLIB""$(ext_obj)".a" ; done)
endif
#=================================================================================
#=================================================================================
#=================================================================================
#=================================================================================
$(info ***********************************************************************)
$(info ***********Library name:    $(LIB_NAME))
$(info ***********Library version: $(LIB_VERSION))
$(info ***********OS:              $(OS))
$(info ***********COMPILER:        $(FC))
$(info ***********COMPILER_VER:    $(FC_VER))
$(info ***********OPTIMIZATION:    $(OPT))
$(info ***********OpenMP:          $(OMP))
$(info ***********INT:             $(INT))
$(info ***********RKIND:           $(RKIND))
$(info ***********WITHRK16:        $(WWITHRK16))
$(info ***********LAPACK:          $(LAPACK))
$(info ***********FFLAGS:          $(FFLAGS))
$(info ***********FLIB:            $(FLIB))
$(info ***********ext_obj:         $(ext_obj))
$(info )
$(info ***********ExtLibDIR:       $(ExtLibDIR))
$(info ***********EXTLib:          $(EXTLib))
$(info ***********EXTMod:          $(EXTMod))
$(info )
$(info ***********EXTMODEL_DIR:    $(EXTMODEL_DIR))
$(info ***********************************************************************)
#
SRCPATH := $(shell find $(SRC_DIR)/* -maxdepth 1 -type d )
VPATH := $(APP_DIR):$(TESTS_DIR):$(SRC_DIR):$(SRCPATH)
#
include scripts/fortranlist.mk

OBJ0=$(SRCFILES:.f90=.o)
OBJ=$(addprefix $(OBJ_DIR)/, $(OBJ0))

ifeq ($(DEGUB),T) 
  $(info ***********SRCPATH:         $(SRCPATH))
  $(info ***********OBJ files:       $(OBJ))
endif
#===============================================
#============= Main programs: tests + example ==
#
.PHONY: all
all: lib $(APPEXE) $(TESTEXE)

#===============================================
#================ Example(s) ===================
#===============================================
SRCAPPFILES := $(notdir $(shell ls $(APP_DIR)/*f90))
OBJAPP      := $(addprefix $(OBJ_DIR)/, $(SRCAPPFILES:.f90=.o))
APPEXE      := $(SRCAPPFILES:.f90=.x)
#
ifeq ($(DDEBUG),t)
  $(info ***********SRCAPPFILES:     $(SRCAPPFILES))
  $(info ***********OBJ app files:   $(OBJAPP))
  $(info ***********app test exe:    $(APPEXE))
  $(info ***********************************************************************)
endif
#
.PHONY: app
app: $(APPEXE)
	@echo "Application compilation: OK"
#
#===============================================
#================ unitary tests ================
#===============================================
SRCTESTFILES := $(notdir $(shell ls $(TESTS_DIR)/*.f90))
OBJTEST      := $(addprefix $(OBJ_DIR)/, $(SRCTESTFILES:.f90=.o))
TESTEXE      := $(SRCTESTFILES:.f90=.x)
NEWTESTEXE   := $(filter-out TEST_model.x, $(TESTEXE))

#
ifeq ($(DDEBUG),t)
  $(info ***********SRCTESTFILES:    $(SRCTESTFILES))
  $(info ***********OBJ test files:  $(OBJTEST))
  $(info ***********app test exe:    $(TESTEXE))
  $(info ***********app nextest exe: $(NEWTESTEXE))
  $(info ***********************************************************************)
endif
#
.PHONY: ut
ut: $(TESTEXE)
	@echo "model (QML) compilation: OK"
	cd $(TESTS_DIR) ; ./run_test_QML $(FFC) $(OOPT) $(OOMP) $(LLAPACK) $(INT) 1
	mkdir -p $(TESTSOUT_DIR)
	cd $(TESTSOUT_DIR) ; rm -f *.log ; $(foreach Texe,$(NEWTESTEXE), ../../$(Texe) >>  Test.log ;)
	@grep "Number of error(s)" $(TESTSOUT_DIR)/Test.log
	@awk  -F: 'BEGIN{test=0} /Number of tests/ {test+=$$2} END {print "Number of tests: " test}' $(TESTSOUT_DIR)/Test.log
	@awk  -F: 'BEGIN{err=0} /Number of error/ {err=err+$$2} END {print "Number of error(s) for all tests: " err}' $(TESTSOUT_DIR)/Test.log
	@echo "  done Tests"
#
#===============================================
#===============================================
#============= compilation =====================
#===============================================
#
$(OBJ_DIR)/%.o: %.f90
	$(FC) $(FFLAGS) -o $@ -c $<
#
%.x: $(OBJ_DIR)/%.o $(LIBAF)
	$(FC) $(FFLAGS) -o $@ $< $(LIBAF) $(FLIB)
	@echo $@ compilation: OK
#
# Special rule for the external model
.PHONY: ln_ExtModel
ln_ExtModel: $(MAIN_path)/$(SRC_DIR)/QML/ExtModel_m.f90
#
$(MAIN_path)/$(SRC_DIR)/QML/ExtModel_m.f90:
	ln -s  $(MAIN_path)/Ext_Model/ExtModel_m.f90 $(MAIN_path)/$(SRC_DIR)/QML/ExtModel_m.f90
#
#===============================================
#============= object directory  ===============
#===============================================
$(OBJ_DIR):
	mkdir -p $(OBJ_DIR)
	rm -f  $(OBJOLD_DIR)
	cd OBJ && ln -s obj$(ext_obj) obj$(extold_obj)
	@echo OBJ_DIR: $(OBJ_DIR)
#===============================================
#============= Main library ====================
#===============================================
LIBAshort      := lib$(LIB_NAME).a
LIBA           := lib$(LIB_NAME)$(ext_obj).a
LIBAOLD        := lib$(LIB_NAME)$(extold_obj).a

LIBAF          := lib$(LIB_NAME)Full$(ext_obj).a
LIBAFOLD       := libQMLFull$(extold_obj).a
LIBAFshort     := libQMLFull.a

#
.PHONY: lib
lib: $(LIBA) $(LIBAF)

$(LIBA): $(OBJ)
	ar -cr $(LIBA) $(OBJ)
	rm -f  $(LIBAOLD)
	ln -s  $(LIBA) $(LIBAOLD)
	rm -f $(LIBAshort)
	ln -s  $(LIBA) $(LIBAshort)
	@echo "  done Library: "$(LIBA)
$(LIBAF): $(OBJ)
	ar -cr $(LIBAF) $(OBJ) $(EXTLibOBJ)
	rm -f  $(LIBAFOLD)
	ln -s  $(LIBAF) $(LIBAFOLD)
	rm -f $(LIBAFshort)
	ln -s  $(LIBAF) $(LIBAFshort)
	@echo "  done Library (including external libraries): "$(LIBAF)
#===============================================
#===============================================
#============= External libraries  =============
#===============================================
.PHONY: getlib
getlib: $(EXTLib)
#
$(EXTLib):
	$(MAKE) -C $(ExtLibDIR) -f $(MAIN_path)/scripts/makefile-extlib LIBA=$@
#===============================================
#================ cleaning =====================
.PHONY: clean cleanall cleanlocextlib
clean:
	rm -f  $(TESTEXE) $(APPEXE)
	rm -f  *.log
	rm -fr *.dSYM
	rm -fr build
	rm -f $(MAIN_path)/$(SRC_DIR)/QML/ExtModel_m.f90
	rm -f $(OBJ_DIR)/*.o $(OBJ_DIR)/*.mod $(OBJ_DIR)/*.MOD
	@echo "  done cleaning for "$(LIB_NAME)
cleanall: clean
	rm -f lib*.a
	rm -rf OBJ
	cd $(TESTS_DIR) && ./clean
	if [ "$(EXTLIB_LIST)" != "" -a "$(RECCLEAN)" = "1" ]; then ./scripts/cleanExtLib cleanall "$(ExtLibDIR)" "$(EXTLIB_LIST)" 0; fi  
	@echo "  done remove the *.a libraries and the OBJ directory for "$(LIB_NAME)
cleanlocextlib: clean
	rm -f lib*.a
	rm -rf OBJ
	cd $(TESTS_DIR) && ./clean
	if [ "$(EXTLIB_LIST)" != "" -a "$(RECCLEAN)" = "1" ] ; then ./scripts/cleanExtLib cleanlocextlib "$(ExtLibDIR)" "$(EXTLIB_LIST)" 0; fi 
	@echo "  done remove all local library directories (..._loc) for "$(LIB_NAME)
#===============================================
#============= make dependencies ===============
#===============================================
.PHONY: dep
scripts/dependencies.mk scripts/fortranlist.mk dep:
	./scripts/dependency.sh
#===============================================
#============= module dependencies =============
#===============================================
$(OBJ) $(OBJAPP) $(OBJTEST):          | $(OBJ_DIR)
$(OBJAPP):                   $(LIBAF) | $(EXTLib)
$(OBJTEST):                  $(LIBAF) | $(EXTLib)
$(OBJ):                               | $(EXTLib)
include scripts/dependencies.mk
#===============================================