Skip to content

Commit

Permalink
Small changes
Browse files Browse the repository at this point in the history
  • Loading branch information
talbring committed Nov 28, 2019
1 parent 9a897e6 commit a1d1e6b
Show file tree
Hide file tree
Showing 11 changed files with 18 additions and 14 deletions.
1 change: 1 addition & 0 deletions _data/docs_v7.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
- title: Installation
docs_v7:
- Download
- Software-Components
- Installation
- SU2-Linux-MacOS
- SU2-Windows
Expand Down
1 change: 0 additions & 1 deletion _docs_v7/Build-SU2-Linux-MacOS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ permalink: /docs_v7/Build-SU2-Linux-MacOS/
redirect_from: /docs/Build-SU2-From-Source/
---

***This guide is for version 7 only.***
For information on how to build older versions of SU2, have a look [here](/docs_v7/Build-from-Source/).

Note that the following guide works only on Linux/MacOS and on Windows using Cygwin or the [Linux Subsystem](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
Expand Down
1 change: 0 additions & 1 deletion _docs_v7/Build-SU2-Windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Build SU2 on Windows
permalink: /docs_v7/Build-SU2-Windows/
---

***This guide is for version 7 only.***
This document will guide you through the steps to compile SU2 on Windows using the [Minimalist GNU for Windows
](http://www.mingw.org/) development environment (MinGW) and [Microsoft MPI](https://docs.microsoft.com/en-us/message-passing-interface/microsoft-mpi).

Expand Down
2 changes: 1 addition & 1 deletion _docs_v7/Execution.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ where `SU2_MODULE` can be any of the C++ modules on the [Software Components](/d
```
$ ./SU2_CFD default.cfg
```
where the executable, SU2_CFD, and the [Configuration File](/docs_v7/Configuration-File/), default.cfg, are located in the current working directory. Please see the [Build from Source](/docs_v7/Build-SU2-from-Source/) page for how you can set up environment variables to run the modules from any directory. Additionally, SU2 is a fully-parallel suite, and assuming that you have compiled with MPI support, each of the modules can be executed in parallel. For example, to run the CFD solver on 8 cores, you might enter:
where the executable, SU2_CFD, and the [Configuration File](/docs_v7/Configuration-File/), default.cfg, are located in the current working directory. Please see the [Build from Source](/docs_v7/Build-SU2-Linux-MacOS/) page for how you can set up environment variables to run the modules from any directory. Additionally, SU2 is a fully-parallel suite, and assuming that you have compiled with MPI support, each of the modules can be executed in parallel. For example, to run the CFD solver on 8 cores, you might enter:
```
$ mpirun -n 8 SU2_CFD default.cfg
```
Expand Down
2 changes: 1 addition & 1 deletion _docs_v7/Mesh-File.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ MESH_FORMAT= CGNS

It is important to note that SU2 will not use any specific boundary conditions that are embedded within the CGNS mesh. However, it *will* use the names given to each boundary as the marker tags. These marker tags are used to set the boundary conditions in the configuration file. Therefore, it is recommended that the user give names to each boundary in their mesh generation package before exporting to CGNS. If you do not know the number of markers or their tags within a CGNS file, you can simply attempt a simulation in SU2_CFD (leaving out the boundary information in the configuration file at first), and during the preprocessing stage, SU2 will read and print the names of all boundary markers to the console along with other grid information before throwing an error due to incomplete boundary definitions. The user can then incorporate these marker tags into the configuration file with the appropriate boundary conditions.

If needed, a converter from CGNS to the SU2 format has been built into SU2 (See the [inviscid wedge tutorial](../tutorials/Inviscid_Wedge)).
If needed, a converter from CGNS to the SU2 format has been built into SU2 (See the [inviscid wedge tutorial](/tutorials/Inviscid_Wedge)).

## Third-Party Mesh Software

Expand Down
6 changes: 3 additions & 3 deletions _docs_v7/Physical-Definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ SU2 offers different ways of setting and computing this definition. This documen
- [Free-Stream Definition (Compressible)](#free-stream-definition-compressible)
- [Thermodynamic State](#thermodynamic-state)
- [Mach Number and Velocity](#mach-number-and-velocity)
- [Reynolds Number and Viscosity ###](#reynolds-number-and-viscosity)
- [Reynolds Number and Viscosity](#reynolds-number-and-viscosity)
- [Non-Dimensionalization](#non-dimensionalization)
- [Flow Condition (Incompressible)](#flow-condition-incompressible)
- [Thermodynamic and Gauge Pressure](#thermodynamic-and-gauge-pressure)
Expand Down Expand Up @@ -64,7 +64,7 @@ The thermodynamic state of the free-stream is defined by the pressure $$p_{\inft

The free-stream velocity $$v_{\infty}$$ is always computed from the specified Mach number $$Ma_{\infty}$$ (`MACH_NUMBER`) and the computed thermodynamic state. The flow direction is based on the angle of attack (`AOA`) and the side-slip angle (`SIDESLIP_ANGLE`, for 3D).

### Reynolds Number and Viscosity ###
### Reynolds Number and Viscosity ###

If it is a viscous computation, by default the pressure $$p_{\infty}$$ will be recomputed from a density $$\rho_{\infty}$$ that is found from the specified Reynolds number $$Re$$ (`REYNOLDS_NUMBER`). Note that for an ideal gas this does not change the Mach number $$Ma_{\infty}$$ as it is only a function of the temperature $$T_{\infty}$$. If you still want to use the thermodynamic state for the free-stream definition, set the option `INIT_OPTION` to `TD_CONDITIONS` (default: `REYNOLDS`). In both cases, the viscosity is computed from the dimensional version of Sutherland's law or the constant viscosity (`FREESTREAM_VISCOSITY`), depending on the `VISCOSITY_MODEL` option.

Expand All @@ -83,7 +83,7 @@ For all schemes, as reference values for the density and temperature the free-st
| --- | --- |
| `INC_EULER`, `INC_NAVIER_STOKES`, `INC_RANS` | 7.0.0 |

The physical definition of the incompressible solvers is accomplished by setting an appropriate flow condition for initialization and non-dimensionalization. SU2 solves the [incompressible Navier-Stokes equations](/docs_v7/Theory/#incompressible-rans) in a general form allowing for variable density due to heat transfer through the low-Mach approximation (or incompressible ideal gas formulation).
The physical definition of the incompressible solvers is accomplished by setting an appropriate flow condition for initialization and non-dimensionalization. SU2 solves the [incompressible Navier-Stokes equations](/docs_v7/Theory/#incompressible-navier-stokes) in a general form allowing for variable density due to heat transfer through the low-Mach approximation (or incompressible ideal gas formulation).

### Thermodynamic and Gauge Pressure ###

Expand Down
2 changes: 1 addition & 1 deletion _docs_v7/Quick-Start.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Next, we want to run the adjoint solution to get the sensitivity of the objectiv
- **restart_adj_cd.dat** - restart file in an internal format for restarting this simulation in SU2. Note that the name of the objective appears in the file name.
- **history.dat** or **history.csv** - file containing the convergence history information.

Note that as of SU2 v4.1, you can also compute a discrete adjoint for the Euler equations. Assuming that you have built the code with [algorithmic differentiation support](/docs_v7/Build-SU2-From-Source/#basic-configuration), you can run the discrete adjoint with the following steps instead:
Note that as of SU2 v4.1, you can also compute a discrete adjoint for the Euler equations. Assuming that you have built the code with [algorithmic differentiation support](/docs_v7/Build-SU2-Linux-MacOS/#basic-configuration), you can run the discrete adjoint with the following steps instead:
1. Open the config file and change the parameter `MATH_PROBLEM` from `DIRECT` to `DISCRETE_ADJOINT`, and save this file.
2. Rename the restart file (restart_flow.dat) to "solution_flow.dat" so that the adjoint code has access to the direct flow solution.
3. Run the executable again by entering `SU2_CFD_AD inv_NACA0012.cfg` at the command line. Note that the `SU2_CFD_AD` executable will only be available when the source has been compiled with AD support.
Expand Down
9 changes: 9 additions & 0 deletions _docs_v7/Software-Components.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@ title: Software Components
permalink: /docs_v7/Software-Components/
---


---

- [C++ Software Modules](#c-software-modules)
- [Algorithmic Differentiation Support and Discrete Adjoint](#algorithmic-differentiation-support-and-discrete-adjoint)
- [Python Scripts](#python-scripts)

---

The SU2 software suite is composed of a set of C++ based software modules that perform a wide range of CFD analysis and PDE-constrained optimization tasks. An overall description of each module is included below to give perspective on the suite's capabilities, while more details can be found in the Developer's Guide. Some modules can be executed individually, most notably SU2_CFD to perform high-fidelity analysis, but the real power of the suite lies in the coupling of the modules to perform complex activities, including design optimization and adaptive grid refinement, among others.

A key feature of the C++ modules is that each has been designed to separate functionality as much as possible and to leverage the advantages of the class-inheritance structure of the programming language. This makes SU2 an ideal platform for prototyping new numerical methods, discretization schemes, governing equation sets, mesh perturbation algorithms, adaptive mesh refinement schemes, parallelization schemes, etc. You simply need to define a new subclass and get down to business. This philosophy makes SU2 quickly extensible to a wide variety of PDE analyses suited to the needs of the user, and work is ongoing to incorporate additional features for future SU2 releases.
Expand Down
2 changes: 0 additions & 2 deletions _docs_v7/Solver-Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Solver Setup
permalink: /docs_v7/Solver-Setup/
---

**This guide is for version 7 only**

This is a basic introduction on how to set up a simulation using SU2. We distinguish between single-zone computations and multi-zone computations. The following considers a single zone only. For an explanation on multi-zone problems, continue with [Basics of Multi-Zone Computations](/docs_v7/Multizone).

---
Expand Down
2 changes: 0 additions & 2 deletions _docs_v7/Theory.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Governing Equations in SU2
permalink: /docs_v7/Theory/
---

**This guide is for version 7 only**

This page contains a very brief summary of the different governing equation sets that are treated in each of the solvers within SU2. The reader will be referred to other references for the full detail of the numerical implementations, but we will also describe the approaches at a high level here.

---
Expand Down
4 changes: 2 additions & 2 deletions _includes/tutorials_section_nav.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
{% assign previous = forloop.index0 | minus: 1 %}
{% assign previous_page = tutorials[previous] | prepend:"/tutorials/" | append:"/" %}
<li class="previous">
<a href="{{ previous_page | prepend: site.baseurl }}">
<a href="{{ previous_page | relative_url }}">
<span aria-hidden="true">&larr;</span> Previous
</a>
</li>
Expand All @@ -40,7 +40,7 @@
{% assign next = forloop.index0 | plus: 1 %}
{% assign next_page = tutorials[next] | prepend:"/tutorials/" | append:"/" %}
<li class="next">
<a href="{{ next_page | prepend: site.baseurl }}">
<a href="{{ next_page | relative_url }}">
Next <span aria-hidden="true">&rarr;</span>
</a>
</li>
Expand Down

0 comments on commit a1d1e6b

Please sign in to comment.