Added friction tensor to AWH manual section
[gromacs.git] / cmake / gmxTestCXX11.cmake
bloba9d58547a76cb38c75d62e8871526969154d2c03
2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 2012,2013,2014,2015,2016,2017, by the GROMACS development team, led by
5 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 # and including many others, as listed in the AUTHORS file in the
7 # top-level source directory and at http://www.gromacs.org.
9 # GROMACS is free software; you can redistribute it and/or
10 # modify it under the terms of the GNU Lesser General Public License
11 # as published by the Free Software Foundation; either version 2.1
12 # of the License, or (at your option) any later version.
14 # GROMACS is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 # Lesser General Public License for more details.
19 # You should have received a copy of the GNU Lesser General Public
20 # License along with GROMACS; if not, see
21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
24 # If you want to redistribute modifications to GROMACS, please
25 # consider that scientific software is very special. Version
26 # control is crucial - bugs must be traceable. We will be happy to
27 # consider code for inclusion in the official distribution, but
28 # derived work must not be called official GROMACS. Details are found
29 # in the README & COPYING files - if they are missing, get the
30 # official version at http://www.gromacs.org.
32 # To help us fund GROMACS development, we humbly ask that you cite
33 # the research papers on the package. Check out http://www.gromacs.org.
35 include(CheckCXXSourceCompiles)
37 # Check whether both a suitable C++11-compatible compiler and standard
38 # library is available, and give a fatal error if not.
40 # Any required compiler flag for C++11 support is returned in
41 # ${FLAG}. The other parameters are only inputs, naming variables that
42 # contain flags that may have been detected, or set by the user.
43 function(GMX_TEST_CXX11 CXX11_CXX_FLAG_NAME STDLIB_CXX_FLAG_NAME STDLIB_LIBRARIES_NAME)
45     # First check that the compiler is OK, and find the appropriate flag.
47     if(WIN32 AND NOT MINGW)
48         set(CXX11_CXX_FLAG "/Qstd=c++11")
49     elseif(CYGWIN)
50         set(CXX11_CXX_FLAG "-std=gnu++11") #required for strdup
51     else()
52         set(CXX11_CXX_FLAG "-std=c++11")
53     endif()
54     CHECK_CXX_COMPILER_FLAG("${CXX11_CXX_FLAG}" CXXFLAG_STD_CXX0X)
55     if(NOT CXXFLAG_STD_CXX0X)
56         set(CXX11_CXX_FLAG "")
57     endif()
58     set(CMAKE_REQUIRED_FLAGS "${CXX11_CXX_FLAG}")
59     check_cxx_source_compiles(
60 "// Permit testing typeid keyword
61 #include <typeinfo>
62 // Test that a subclass has a proper copy constructor
63 struct a {
64   a() {};
65   a(const a&) {};
66   a(a&&) = delete;
68 class b: public a
71 b bTest() {
72   return b();
74 // ICC requires that a suitable GCC is available. It is using its standard library and emulates
75 // GCC behaviour based on its version. Relevant here it emulates the implementation of the move
76 // constructor. This compiler check should only fail based on the compiler not GCC. The GCC version
77 // is checked by the following STL check. It is known that all ICC>=15 have the proper move
78 // constructor. Thus this check is disabled for ICC.
79 #if !((defined __INTEL_COMPILER && __INTEL_COMPILER >= 1500) || (defined __ICL && __ICL >= 1500))
80 // Test that a subclass has a proper move constructor
81 struct c {
82   c() {};
83   c(const c&) = delete;
84   c(c&&) {};
86 struct d : public c {
88 d dTest() {
89   return d();
91 #endif
92 struct e {
93   // Test that operator bool() works
94   explicit operator bool() {return true;}
95   // Test that an in-class initializer works
96   int x = 1;
97   // Test that a default constructor is generated
98   e() = default;
100 // Test that constexpr works
101 constexpr int factorial(int n)
103     return n <= 1? 1 : (n * factorial(n - 1));
105 // Test that r-value references work
106 void checkRvalueReference(int &&);
107 // Test that extern templates work
108 template <typename T> void someFunction();
109 extern template void someFunction<int>();
110 // Test using statement
111 using myInt = int;
112 // Test template using statement
113 template<class T> using myPointer = T*;
114 myPointer<int> x;
115 int main() {
116   // Test nullptr
117   double *x = nullptr;
118   (void)x; // Suppressing unused variable warning
119   // Test range-based for loops
120   int array[5] = { 1, 2, 3, 4, 5 };
121   for (int& x : array)
122     x *= 2;
123   // Test alignas
124   alignas(4*sizeof(int)) int y;
125   // Test typeid
126   const std::type_info &intType = typeid(int);
127   // Test static assertions do compile
128   static_assert(true, \"if you see this, true somehow isn't\");
129   // Test a lambda
130   [=]{};
131 }" CXX11_SUPPORTED)
132     if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
133         if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "4.8.1")
134             message(FATAL_ERROR "GROMACS requires version 4.8.1 or later of the GNU C++ compiler for complete C++11 support")
135         endif()
136     elseif("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
137         if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "3.3")
138             message(FATAL_ERROR "GROMACS requires version 3.3 or later of the Clang C++ compiler for complete C++11 support")
139         endif()
140     elseif("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Intel")
141         if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "15.0")
142             message(FATAL_ERROR "GROMACS requires version 15.0 or later of the Intel C++ compiler for complete C++11 support")
143         endif()
144     elseif("${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC")
145         if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "19.0.23026")
146             message(FATAL_ERROR "GROMACS requires version 2015 (19.0.23026) or later of the MSVC C++ compiler for complete C++11 support")
147         endif()
148     endif()
149     if(CXX11_SUPPORTED)
150         set(${CXX11_CXX_FLAG_NAME} ${CXX11_CXX_FLAG} PARENT_SCOPE)
151     else()
152         message(FATAL_ERROR "This version of GROMACS requires a C++11 compiler. Please use a newer compiler or use the GROMACS 5.1.x release. See the installation guide for details.")
153     endif()
155     # Now check the standard library is OK
157     set(CMAKE_REQUIRED_FLAGS "${CXX11_CXX_FLAG} ${${STDLIB_CXX_FLAG_NAME}}")
158     set(CMAKE_REQUIRED_LIBRARIES "${${STDLIB_LIBRARIES_NAME}}")
159     check_cxx_source_compiles(
160 "#include <algorithm>
161 #include <array>
162 #include <chrono>
163 #include <iterator>
164 #include <map>
165 #include <memory>
166 #include <thread>
167 #include <type_traits>
168 #include <tuple>
169 #include <utility>
170 #include <string>
171 #include <vector>
172 int main() {
173   // Test for std::vector
174   std::vector<double> doubles(100);
175   // Test for std::array
176   std::array<int, 3> someInts;
177   // Test std::for_each and a lambda
178   std::for_each(std::begin(doubles), std::end(doubles), [&](double &d) { d = 2.3; });
179   // Test std::unique_ptr
180   typedef std::unique_ptr<int> intPointer;
181   // Test using std::unique_ptr
182   intPointer p(new int(10));
183   // Test std::map
184   std::map<int, std::unique_ptr<int>> m;
185   // Test std::make_pair
186   m.insert(std::make_pair(5, std::move(p)));
187   // Test std::chrono (was missing before gcc 4.8.1)
188   auto start = std::chrono::steady_clock::now();
189   if (std::chrono::steady_clock::now() - start < std::chrono::seconds(2))
190   {
191       // Test std::thread
192       std::thread t;
193   }
194   // Test std::is_pod
195   static_assert(std::is_pod<int>::value, \"int isn't pod\");
196   // Test std::tuple
197   auto theTuple = std::make_tuple<int, double>(3, 4.2);
198   // Test std::tie
199   int tupleInt;
200   double tupleDouble;
201   std::tie(tupleInt, tupleDouble) = theTuple;
202   // Test std::string
203   std::string message(\"hello\");
204 }" CXX11_STDLIB_PRESENT)
205     if(NOT CXX11_STDLIB_PRESENT)
206         if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Intel" AND CMAKE_CXX_COMPILER_VERSION VERSION_LESS "16.0.3")
207             message(FATAL_ERROR "GROMACS requires that the Intel C++ compiler use a compatible C++ standard library, for complete C++11 support, however not all compiler versions support all possible standard library implementations. In particular, before icc version 16.0.3, the gcc version 5 standard library was not supported. If you are affected by such a case you should probably update your compiler version. Consult the GROMACS installation guide to check exactly what is supported and how to direct the use of a standard library from an older gcc version (but at least version 4.8.1 is needed).")
208         else()
209             message(FATAL_ERROR "This version of GROMACS requires C++11-compatible standard library. Please use a newer compiler, and/or a newer standard library, or use the GROMACS 5.1.x release. Consult the installation guide for details before upgrading components.")
210         endif()
211     endif()
212 endfunction()