(git:e966546)
Loading...
Searching...
No Matches
cp2k_info.F
Go to the documentation of this file.
1!--------------------------------------------------------------------------------------------------!
2! CP2K: A general program to perform molecular dynamics simulations !
3! Copyright 2000-2025 CP2K developers group <https://cp2k.org> !
4! !
5! SPDX-License-Identifier: GPL-2.0-or-later !
6!--------------------------------------------------------------------------------------------------!
7
8! **************************************************************************************************
9!> \brief some minimal info about CP2K, including its version and license
10!> \par History
11!> - created (2007-09, Joost VandeVondele)
12!> - moved into this module information related to runtime:pid, user_name,
13!> host_name, cwd, timestamp (2009-06, Teodoro Laino, 2025-08 MK)
14!> \author Joost VandeVondele
15! **************************************************************************************************
16MODULE cp2k_info
17
18 USE iso_fortran_env, ONLY: compiler_options
19 USE kinds, ONLY: default_path_length,&
20 default_string_length
21 USE machine, ONLY: m_getcwd,&
22 m_getlog,&
23 m_getpid,&
24 m_hostnm,&
25 m_timestamp,&
26 timestamp_length
27 USE string_utilities, ONLY: integer_to_string
28
29 IMPLICIT NONE
30 PRIVATE
31
32 PUBLIC :: cp2k_version, cp2k_year, cp2k_home, cp2k_flags
33 PUBLIC :: compile_arch, compile_date, compile_host, compile_revision
34 PUBLIC :: print_cp2k_license, get_runtime_info, write_restart_header
35
36#if defined(__COMPILE_REVISION)
37 CHARACTER(LEN=*), PARAMETER :: compile_revision = __compile_revision
38#else
39 CHARACTER(LEN=*), PARAMETER :: compile_revision = "unknown"
40#endif
41
42 !!! Keep version in sync with CMakeLists.txt !!!
43 CHARACTER(LEN=*), PARAMETER :: cp2k_version = "CP2K version 2025.2 (Development Version)"
44 CHARACTER(LEN=*), PARAMETER :: cp2k_year = "2025"
45 CHARACTER(LEN=*), PARAMETER :: cp2k_home = "https://www.cp2k.org/"
46
47 ! compile time information
48#if defined(__COMPILE_ARCH)
49 CHARACTER(LEN=*), PARAMETER :: compile_arch = __compile_arch
50#else
51 CHARACTER(LEN=*), PARAMETER :: compile_arch = "unknown: -D__COMPILE_ARCH=?"
52#endif
53
54#if defined(__COMPILE_DATE)
55 CHARACTER(LEN=*), PARAMETER :: compile_date = __compile_date
56#else
57 CHARACTER(LEN=*), PARAMETER :: compile_date = "unknown: -D__COMPILE_DATE=?"
58#endif
59
60#if defined(__COMPILE_HOST)
61 CHARACTER(LEN=*), PARAMETER :: compile_host = __compile_host
62#else
63 CHARACTER(LEN=*), PARAMETER :: compile_host = "unknown: -D__COMPILE_HOST=?"
64#endif
65
66 ! Local runtime informations
67 CHARACTER(LEN=default_path_length), PUBLIC :: r_cwd
68 CHARACTER(LEN=default_string_length), PUBLIC :: r_host_name, r_user_name
69 CHARACTER(LEN=timestamp_length), PUBLIC :: r_timestamp
70 INTEGER, PUBLIC :: r_pid
71
72 CHARACTER(len=*), PARAMETER, PRIVATE :: modulen = 'cp2k_info'
73CONTAINS
74
75! **************************************************************************************************
76!> \brief list all compile time options that influence the capabilities of cp2k.
77!> All new flags should be added here (and be unique grep-able)
78!> \return ...
79! **************************************************************************************************
80 FUNCTION cp2k_flags() RESULT(flags)
81 CHARACTER(len=10*default_string_length) :: flags
82
83 CHARACTER(len=default_string_length) :: tmp_str
84
85 flags = "cp2kflags:"
86
87 ! Ensure that tmp_str is used to silence compiler warnings
88 tmp_str = ""
89 flags = trim(flags)//trim(tmp_str)
90
91 IF (index(compiler_options(), "-fsanitize=leak") > 0) THEN
92 flags = trim(flags)//" lsan"
93 END IF
94
95!$ flags = TRIM(flags)//" omp"
96
97 ! TODO: remove __INTEL_LLVM_COMPILER conditions (regtests)
98#if defined(__INTEL_LLVM_COMPILER)
99 flags = trim(flags)//" ifx"
100#endif
101#if defined(__LIBINT)
102 flags = trim(flags)//" libint"
103#endif
104#if defined(__FFTW3)
105 flags = trim(flags)//" fftw3"
106#endif
107#if defined(__LIBXC)
108 flags = trim(flags)//" libxc"
109#endif
110#if defined(__LIBGRPP)
111 flags = trim(flags)//" libgrpp"
112#endif
113#if defined(__PEXSI)
114 flags = trim(flags)//" pexsi"
115#endif
116#if defined(__ELPA)
117 flags = trim(flags)//" elpa"
118#endif
119#if defined(__ELPA_NVIDIA_GPU)
120 flags = trim(flags)//" elpa_nvidia_gpu"
121#endif
122#if defined(__ELPA_AMD_GPU)
123 flags = trim(flags)//" elpa_amd_gpu"
124#endif
125#if defined(__ELPA_INTEL_GPU)
126 flags = trim(flags)//" elpa_intel_gpu"
127#endif
128#if defined(__parallel)
129 flags = trim(flags)//" parallel scalapack"
130#endif
131#if defined(__MPI_F08)
132 flags = trim(flags)//" mpi_f08"
133#endif
134#if defined(__COSMA)
135 flags = trim(flags)//" cosma"
136#endif
137#if defined(__QUIP)
138 flags = trim(flags)//" quip"
139#endif
140#if defined(__HAS_PATCHED_CUFFT_70)
141 flags = trim(flags)//" patched_cufft_70"
142#endif
143#if defined(__ACE)
144 flags = trim(flags)//" ace"
145#endif
146#if defined(__DEEPMD)
147 flags = trim(flags)//" deepmd"
148#endif
149#if defined(__PW_FPGA)
150 flags = trim(flags)//" pw_fpga"
151#endif
152#if defined(__PW_FPGA_SP)
153 flags = trim(flags)//" pw_fpga_sp"
154#endif
155#if defined(__LIBXSMM)
156 flags = trim(flags)//" xsmm"
157#endif
158#if defined(__CRAY_PM_ACCEL_ENERGY)
159 flags = trim(flags)//" cray_pm_accel_energy"
160#endif
161#if defined(__CRAY_PM_ENERGY)
162 flags = trim(flags)//" cray_pm_energy"
163#endif
164#if defined(__CRAY_PM_FAKE_ENERGY)
165 flags = trim(flags)//" cray_pm_fake_energy"
166#endif
167#if defined(__DBCSR_ACC)
168 flags = trim(flags)//" dbcsr_acc"
169#endif
170#if defined(__MAX_CONTR)
171 CALL integer_to_string(__max_contr, tmp_str)
172 flags = trim(flags)//" max_contr="//trim(tmp_str)
173#endif
174#if defined(__NO_SOCKETS)
175 flags = trim(flags)//" no_sockets"
176#endif
177#if defined(__NO_MPI_THREAD_SUPPORT_CHECK)
178 flags = trim(flags)//" no_mpi_thread_support_check"
179#endif
180#if defined(__NO_STATM_ACCESS)
181 flags = trim(flags)//" no_statm_access"
182#endif
183#if defined(__MINGW)
184 flags = trim(flags)//" mingw"
185#endif
186#if defined(__PW_CUDA_NO_HOSTALLOC)
187 flags = trim(flags)//" pw_cuda_no_hostalloc"
188#endif
189#if defined(__STATM_RESIDENT)
190 flags = trim(flags)//" statm_resident"
191#endif
192#if defined(__STATM_TOTAL)
193 flags = trim(flags)//" statm_total"
194#endif
195#if defined(__PLUMED2)
196 flags = trim(flags)//" plumed2"
197#endif
198#if defined(__HAS_IEEE_EXCEPTIONS)
199 flags = trim(flags)//" has_ieee_exceptions"
200#endif
201#if defined(__NO_ABORT)
202 flags = trim(flags)//" no_abort"
203#endif
204#if defined(__SPGLIB)
205 flags = trim(flags)//" spglib"
206#endif
207#if defined(__ACCELERATE)
208 flags = trim(flags)//" accelerate"
209#endif
210#if defined(__MKL)
211 flags = trim(flags)//" mkl"
212#endif
213#if defined(__DFTD4)
214 flags = trim(flags)//" libdftd4"
215#endif
216#if defined(__TBLITE)
217 flags = trim(flags)//" mctc-lib"
218 flags = trim(flags)//" tblite"
219#endif
220#if defined(__SIRIUS)
221 flags = trim(flags)//" sirius"
222#endif
223#if defined(__SIRIUS_NLCG)
224 flags = trim(flags)//" sirius_nlcg"
225#endif
226#if defined(__SIRIUS_DFTD4)
227 flags = trim(flags)//" sirius_dftd4"
228#endif
229#if defined(__SIRIUS_VCSQNM)
230 flags = trim(flags)//" sirius_vcsqnm"
231#endif
232#if defined(__CHECK_DIAG)
233 flags = trim(flags)//" check_diag"
234#endif
235#if defined(__LIBVORI)
236 flags = trim(flags)//" libvori"
237 flags = trim(flags)//" libbqb"
238#endif
239#if defined(__LIBMAXWELL)
240 flags = trim(flags)//" libmaxwell"
241#endif
242#if defined(__LIBTORCH)
243 flags = trim(flags)//" libtorch"
244#endif
245#if defined(__OFFLOAD_CUDA)
246 flags = trim(flags)//" offload_cuda"
247#endif
248#if defined(__OFFLOAD_HIP)
249 flags = trim(flags)//" offload_hip"
250#endif
251#if defined(__OFFLOAD_OPENCL)
252 flags = trim(flags)//" offload_opencl"
253#endif
254#if defined(__NO_OFFLOAD_GRID)
255 flags = trim(flags)//" no_offload_grid"
256#endif
257#if defined(__NO_OFFLOAD_DBM)
258 flags = trim(flags)//" no_offload_dbm"
259#endif
260#if defined(__NO_OFFLOAD_PW)
261 flags = trim(flags)//" no_offload_pw"
262#endif
263#if defined(__OFFLOAD_PROFILING)
264 flags = trim(flags)//" offload_profiling"
265#endif
266#if defined(__SPLA) && defined(__OFFLOAD_GEMM)
267 flags = trim(flags)//" spla_gemm_offloading"
268#endif
269#if defined(__CUSOLVERMP)
270 flags = trim(flags)//" cusolvermp"
271#endif
272#if defined(__DLAF)
273 flags = trim(flags)//" dlaf"
274#endif
275#if defined(__LIBVDWXC)
276 flags = trim(flags)//" libvdwxc"
277#endif
278#if defined(__HDF5)
279 flags = trim(flags)//" hdf5"
280#endif
281#if defined(__TREXIO)
282 flags = trim(flags)//" trexio"
283#endif
284#if defined(__OFFLOAD_UNIFIED_MEMORY)
285 flags = trim(flags)//" offload_unified_memory"
286#endif
287#if defined(__SMEAGOL)
288 flags = trim(flags)//" libsmeagol"
289#endif
290#if defined(__GREENX)
291 flags = trim(flags)//" greenx"
292#endif
293
294 END FUNCTION cp2k_flags
295
296! **************************************************************************************************
297!> \brief ...
298!> \param iunit ...
299! **************************************************************************************************
300 SUBROUTINE print_cp2k_license(iunit)
301
302 INTEGER :: iunit
303
304 WRITE (unit=iunit, fmt="(T2,A)") &
305 "******************************************************************************", &
306 "* *", &
307 "* CP2K: A general program to perform molecular dynamics simulations *", &
308 "* Copyright (C) 2000-2025 CP2K developer group <https://www.cp2k.org/> *", &
309 "* *", &
310 "* This program is free software: you can redistribute it and/or modify *", &
311 "* it under the terms of the GNU General Public License as published by *", &
312 "* the Free Software Foundation, either version 2 of the License, or *", &
313 "* (at your option) any later version. *", &
314 "* *", &
315 "* This program is distributed in the hope that it will be useful, *", &
316 "* but WITHOUT ANY WARRANTY; without even the implied warranty of *", &
317 "* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *", &
318 "* GNU General Public License for more details. *", &
319 "* *", &
320 "* You should have received a copy of the GNU General Public License *", &
321 "* along with this program. If not, see <https://www.gnu.org/licenses/>. *", &
322 "* *", &
323 "******************************************************************************"
324
325 END SUBROUTINE print_cp2k_license
326
327! **************************************************************************************************
328!> \brief ...
329! **************************************************************************************************
330 SUBROUTINE get_runtime_info()
331
332 r_cwd = ""
333 r_host_name = ""
334 r_timestamp = ""
335 r_user_name = ""
336 r_pid = -1
337
338 CALL m_getpid(r_pid)
339 CALL m_getlog(r_user_name)
340 CALL m_hostnm(r_host_name)
341 CALL m_timestamp(r_timestamp)
342 CALL m_getcwd(r_cwd)
343
344 END SUBROUTINE
345
346! **************************************************************************************************
347!> \brief Writes the header for the restart file
348!> \param iunit ...
349!> \par History
350!> 01.2008 [created] - Split from write_restart
351!> \author Teodoro Laino - University of Zurich - 01.2008
352! **************************************************************************************************
353 SUBROUTINE write_restart_header(iunit)
354 INTEGER, INTENT(IN) :: iunit
355
356 CHARACTER(LEN=256) :: cwd
357 CHARACTER(LEN=timestamp_length) :: timestamp
358
359 CALL m_timestamp(timestamp)
360 CALL m_getcwd(cwd)
361
362 WRITE (unit=iunit, fmt="(T2,A)") "# Version information for this restart file "
363 WRITE (unit=iunit, fmt="(T2,A)") "# current date "//timestamp
364 WRITE (unit=iunit, fmt="(T2,A)") "# current working dir "//trim(cwd)
365
366 WRITE (unit=iunit, fmt="(T2,A,T31,A50)") &
367 "# Program compiled at", &
368 adjustr(compile_date(1:min(50, len(compile_date))))
369 WRITE (unit=iunit, fmt="(T2,A,T31,A50)") &
370 "# Program compiled on", &
371 adjustr(compile_host(1:min(50, len(compile_host))))
372 WRITE (unit=iunit, fmt="(T2,A,T31,A50)") &
373 "# Program compiled for", &
374 adjustr(compile_arch(1:min(50, len(compile_arch))))
375 WRITE (unit=iunit, fmt="(T2,A,T31,A50)") &
376 "# Source code revision number", &
377 adjustr(compile_revision)
378
379 END SUBROUTINE write_restart_header
380
381END MODULE cp2k_info
cp2k_info
some minimal info about CP2K, including its version and license
Definition cp2k_info.F:16
cp2k_info::r_host_name
character(len=default_string_length), public r_host_name
Definition cp2k_info.F:68
cp2k_info::cp2k_home
character(len= *), parameter, public cp2k_home
Definition cp2k_info.F:45
cp2k_info::compile_host
character(len= *), parameter, public compile_host
Definition cp2k_info.F:63
cp2k_info::compile_arch
character(len= *), parameter, public compile_arch
Definition cp2k_info.F:51
cp2k_info::r_pid
integer, public r_pid
Definition cp2k_info.F:70
cp2k_info::print_cp2k_license
subroutine, public print_cp2k_license(iunit)
...
Definition cp2k_info.F:301
cp2k_info::write_restart_header
subroutine, public write_restart_header(iunit)
Writes the header for the restart file.
Definition cp2k_info.F:354
cp2k_info::compile_revision
character(len= *), parameter, public compile_revision
Definition cp2k_info.F:39
cp2k_info::compile_date
character(len= *), parameter, public compile_date
Definition cp2k_info.F:57
cp2k_info::r_timestamp
character(len=timestamp_length), public r_timestamp
Definition cp2k_info.F:69
cp2k_info::cp2k_year
character(len= *), parameter, public cp2k_year
Definition cp2k_info.F:44
cp2k_info::cp2k_flags
character(len=10 *default_string_length) function, public cp2k_flags()
list all compile time options that influence the capabilities of cp2k. All new flags should be added ...
Definition cp2k_info.F:81
cp2k_info::cp2k_version
character(len= *), parameter, public cp2k_version
Definition cp2k_info.F:43
cp2k_info::r_cwd
character(len=default_path_length), public r_cwd
Definition cp2k_info.F:67
cp2k_info::get_runtime_info
subroutine, public get_runtime_info()
...
Definition cp2k_info.F:331
cp2k_info::r_user_name
character(len=default_string_length), public r_user_name
Definition cp2k_info.F:68
kinds
Defines the basic variable types.
Definition kinds.F:23
kinds::default_string_length
integer, parameter, public default_string_length
Definition kinds.F:57
kinds::default_path_length
integer, parameter, public default_path_length
Definition kinds.F:58
machine
Machine interface based on Fortran 2003 and POSIX.
Definition machine.F:17
machine::m_getpid
subroutine, public m_getpid(pid)
...
Definition machine.F:664
machine::timestamp_length
integer, parameter, public timestamp_length
Definition machine.F:53
machine::m_timestamp
subroutine, public m_timestamp(timestamp)
Returns a human readable timestamp.
Definition machine.F:380
machine::m_getcwd
subroutine, public m_getcwd(curdir)
...
Definition machine.F:616
machine::m_getlog
subroutine, public m_getlog(user)
...
Definition machine.F:741
machine::m_hostnm
subroutine, public m_hostnm(hname)
...
Definition machine.F:583
string_utilities
Utilities for string manipulations.
Definition string_utilities.F:16
string_utilities::integer_to_string
subroutine, public integer_to_string(inumber, string)
Converts an integer number to a string. The WRITE statement will return an error message,...
Definition string_utilities.F:3239