Table of contents

Welcome to the Notus technical documentation.

This documentation provides information on the Notus CFD project in order to:

• take full advantage of the code's capabilities,
• adapt the code for your own applications,
• help volunteers to contribute to the development of the code.

Project description

A presentation of the Notus CFD project with implemented features and roadmap.

Modeling

A brief description of [models and equations] (Brief description of models and equations).

Verification and Validation

Notus CFD is thoroughly verified and validated thanks to an important amount of numerical test cases and adequate processing tools. The Verification and Validation page describes the principal steps and links to the detailed V&V.

Notus guides

If your not already familiar with Notus, please consider reading the following guides:

Installation guide

Installation and developement of Notus is done thanks to the distributed version control system Git. Even if a tarball could be sufficient, we advise to use Git system to follow Notus development and merge easily to new versions. Building Notus from sources requires to compile third party libraries and the use of CMake. These points are detailed below.

• System prerequisites
• Build Third party libraries
• Get Notus on GitLab repository
• Build Notus
• [Run Notus] (How to run Notus) (different ways to execute Notus).

User guide

• Project's files organization to get started with Notus.
• User interface documentation (*NTS* files) to define and run existing or new CFD cases.
• Submitting options to submit NTS files with specific options.
• Database documentation to manipulate the database for the non-regression's process.

Developer guide

The aim of this section is to explain basic ideas, numerical and developement choices done as regards the following points:

• Code overview: let's get started.
• Coding style guidelines: good habits to keep in mind.
• Git merge request preparation guidelines: good habits to keep in mind!

Howtos

Some specific guides around Notus.

Notus environment

• Git usage Git usage
• Atom IDE: configure and use Atom IDE for Notus
• Emacs tips: some Emacs text editor tips

Notus user interface

• Print fields on a set of probe points and/or lines: print fields on a set of probe points and/or lines

Notus development

• User routines: adapt user routines
• Export a variable defined in the .nts file (to Fortran code): export a variable defined in the NTS file (to Fortran code)
• Get the mesh metrics
• Exchange data between processors
• Print a new variable: print a new variable in a BP file
• Add a test case: add a test case to Notus test case bank
• Document your code: correctly and nicely document your code

Best pratices

Some advices around Notus.

Developer's corner

This part of the documentation is intended for advanced developers, where he or she will find useful information on each Module and topic as well as precise descriptions and comments on subroutines, functions, variables, and types. For example, you will find there the documentation for: Modeling, Discretization, Grid, etc.

The detailed descriptions of Verification and validation test cases are also detailed with configurations and expected numerical results.

Complete Fortran code

The complete Fortran source code and its associated documentation is visible in this section.

Glossary

• Glossary: useful terms that everyone should be aware of.

Credits

• Credits: people behind Notus CFD and related articles and communications.