aPriori Documentation
  • 👋Welcome to aPriori
  • Getting started
    • What is aPriori?
    • Installation
    • Quickstart
  • Fundamentals and usage
    • aPriori Fundamentals
      • Data Formatting
      • Cut a 3D scalar
      • Filter a 3D scalar field
      • Initialize a DNS field
      • Data visualization
      • Cut a DNS field
      • Filter a DNS field
    • Machine Learning Tutorials
      • Data-Driven Closure for Turbulence-Chemistry interaction
      • Dynamic Data-Driven Smagorinky Closure for LES
  • API guide
    • Field3D
      • Field3D.build_attributes_list
      • Field3D.check_valid_attribute
      • Field3D.compute_chemical_timescale
      • Field3D.compute_kinetic_energy
      • Field3D.compute_mixing_timescale
      • Field3D.compute_residual_kinetic_energy
      • Field3D.compute_residual_dissipation_rate
      • Field3D.compute_reaction_rates
      • Field3D.compute_reaction_rates_batch
      • Field3D.compute_strain_rate
      • Field3D.compute_tau_r
      • Field3D.compute_velocity_module
      • Field3D.cut
      • Field3D.filter_favre
      • Field3D.filter
      • Field3D.find_path
      • Field3D.plot_x_midplane
      • Field3D.plot_y_midplane
      • Field3D.plot_z_midplane
      • Field3D.print_attributes
      • Field3D.update
    • Scalar3D
      • Scalar3D.is_light_mode
      • Scalar3D.reshape_3d
      • Scalar3D.reshape_column
      • Scalar3D.reshape_line
      • Scalar3D.cut
      • Scalar3D.filter_gauss
      • Scalar3D.plot_x_midplane
      • Scalar3D.plot_y_midplane
      • Scalar3D.plot_z_midplane
    • Mesh3D
  • BIBLIOGRAPHY
Powered by GitBook
On this page
  • Overview
  • Source Code 💻
  • Documentation outline
  • Getting Started
  • Fundamentals and Usage
  • API Guide

Welcome to aPriori

A Python package to process Direct Numerical Simulations of reacting and non-reacting flows.

NextWhat is aPriori?

Last updated 23 days ago

Disclaimer: This webpage may be missing some of the latest functionalities added to the software. Please contact me at lorenzo.piu@ulb.be in case you need any information regarding the code. In the meantime, I am working to keep the documentation updated.

Overview

This guide explains how to use the library and its main features.

The first section introduces the aim of the project, explains how to install the package in your Python environment and provides a code that can be used immediately to perform analysis on a Direct Numerical Simulation (DNS) of a hydrogen flame. The second section goes into more detail, giving examples of how to use the single blocks of the library to obtain the maximum from it. If the code in the quickstart was too complex, this section is the right one to get more insight. The third section clarifies the code from a developer's point of view, explaining each function and the main classes with their attributes and methods. If you are interested in the library as a user, you can skip this section.

💻

The source code is updated and available at the following link on the . In the Tags section, are benchmarked the different releases of the software. Any problem with the code can be reported in the issue section. If you have any further questions regarding the code, don't hesitate to send an e-mail to lorenzo.piu@ulb.be


Documentation outline

Getting Started

Fundamentals and Usage

API Guide

Getting Started
Fundamentals and Usage
API Guide
Source Code
GitHub page
What is aPriori?
Installation
Quickstart
aPriori Fundamentals
Tutorial
Dynamic Data-Driven Smagorinky Closure for LES
Data-Driven Closure for Turbulence-Chemistry Interaction
Field3D
Scalar3D
Mesh3D
👋
Page cover image