For additional help or information about features of the SU2 code not explicitly provided in the present documentation, please check out the forum at cfd-online. The FAQ below covers some of the most commonly asked questions, and you may find that your question has already been answered in an existing thread at the forum.
- Can I use SU2 for my own research?
- Where can I download SU2?
- How do I contact the developers?
- How do I report a bug?
- What types of computational meshes does SU2 support?
- Which visualization packages can I use to view my solutions?
- Where I can get the METIS graph partitioning library?
- Where can I find the test case files?
- I am having trouble with the Python scripts, what can I do?
- I am having trouble compiling SU2 with CGNS. In particular, I see many errors while compiling geometry_structure.cpp. What should I do?
- What is the convention for the freestream flow direction?
- How do I run my simulation for a specific number of iterations?
Can I use SU2 for my own research?
Absolutely! Our goal is to develop and maintain the premier code in the world for PDE analysis and design on unstructured meshes, and a strong user and developer base is vital to the continued growth and development of the SU2 platform. That is why we are freely releasing the suite to the general public under an open source license. Please give our code a try, send any feedback to the developers, and recommend it to your colleagues if you are impressed with the performance. Please read the license details here.
Where can I download SU2?
See the Download page to obtain either the source code or precompiled binary executables for select platforms. Note that SU2 is released under an open source license.
How do I contact the developers?
The developers can be contacted through the developer's mailing list. Send an email directly to the developer's list if you have any feedback, such as bug reports, feature requests, or problems with the code. Your useful questions may end up here in the FAQs section. Users are also encouraged to join the user's mailing list in order to receive important updates on new releases or bug fixes. Instructions for using both mailing lists are found on the Contact page. You can ask questions of the developers and the general CFD community in the forums at cfd-online. In this forum you may also find that your question has already been answered in existing threads (try out the search feature).
How do I report a bug?
Send an email directly to the developer's mailing list address given on the Contact page.
What types of computational meshes does SU2 support?
SU2 supports both a native format (.su2) and the CGNS data standard (.cgns) for mesh input. Please see the page on meshes for detailed descriptions of how to use these two formats with SU2.
Which visualization packages can I use to view my solutions?
SU2 outputs solution files in either VTK format for viewing in ParaView or Tecplot format (ASCII and binary). More information on obtaining these two packages can be found on the installation page.
Where I can get the METIS graph partitioning library?
The METIS graph partitioning software can be found here. However, newer versions of the code do not require the user to download the METIS library. As of version 3.1.0, it is now included in the externals/ folder, and it will be automatically built and linked with during the configure/make process with the autotools.
Where can I find the test case files?
The mesh and configuration files required for the test cases detailed in the user tutorials are now hosted on GitHub (along with additional cases). Please download the test cases from here: https://github.com/su2code/TestCases.
SU2 won't compile, what should I do?
Detailed information on compilation can be found on the installation page. The Autoconf / Automake tools are used in order to build SU2 from source. The typical './configure', 'make', and 'make install' process in the root directory of the source distribution should do the trick. You can provide an install location using the prefix option to configure. If there are issues with autotool version requirements, run the ./bootstrap script provided in the root directory in order to build local versions of the tools and reset the makefiles (before trying configure/make/make install again). Also, check that you have a working C++ compiler, and note that the GNU and Intel C++ compilers are currently the only tested compilers by the developers. If you continue having difficulty or receive repeated compiler errors, please contact the developers.
I am having trouble with the Python scripts, what can I do?
First, see the installation page and make sure that you have a working version of Python (Version 2.6 recommended) on your machine. In limited situations, the scripts may require external packages (namely NumPy and SciPy) which can also be freely obtained. If you are stuck, remember that the options for a specific script can be viewed by entering "python script_name.py -h" at the command line in order to see the help menu. It is important to provide the Python scripts with the correct number of inputs with the correct syntax.
I am having trouble compiling SU2 with CGNS. In particular, I see many errors while compiling geometry_structure.cpp. What should I do?
You may have an older version of CGNS than is incompatible with SU2. We recommend using CGNS version 3.1.4 and linking with the static CGNS library. If you tried building and linking with an older version of CGNS, and then downloaded version 3.1.4, you should remove the old version of CGNS first, before trying to build and link the new version. In addition, please compile the CGNS library in sequential (serial) mode and not parallel. Lastly, the CGNS library should be built without HDF5 support. See the instructions on the meshes page for building SU2 with CGNS.
What is the convention for the freestream flow direction?
SU2 assumes a particular orientation for the computational mesh in 2-D or 3-D space. By convention, for zero angle of attack in a 2-D domain, the freestream is in the direction in the positive x-axis. By adjusting the angle of attack, users will control the component of freestream in the y-direction. For 3-D, the assumed (zero angle) freestream direction remains along the positive x-axis. However, the angle attack will control the flow direction in the x-z plane, while the sideslip angle will control the flow direction in the x-y plane.
How do I run my simulation for a specific number of iterations?
Rather than use the RESIDUAL or CAUCHY options for reaching a certain level of convergence, users can input an integer number of iterations for the solver to perform in the EXT_ITER option in the config file. The simulation will terminate after reaching the specified iteration number.