Getting Started with Tolosa-lib

Getting Started

This guide will help you get started with compiling and running Tolosa-lib examples.

Prerequisites

Before you begin, make sure you have:

• A Fortran compiler (GNU Fortran or Intel Fortran)
• Make utility
• MPI library (for parallel execution)
• Scotch library (for mesh partitioning)

Cloning the Repository

git clone https://github.com/TolosaProject/Tolosa-lib.git
cd Tolosa-lib

Compile a Library Case Example

Tolosa-lib includes several example cases that demonstrate its features.

Basic Compilation

make

This will:

1. Compile all Fortran modules
2. Link the executable
3. Place the executable in the /bin directory

Compilation Options

You can customize the compilation with various options:

# Use Intel compiler
make COMPILER=intel

# Enable debug mode
make DEBUG=yes

# Set optimization level
make OPT=3

Running an Example

After compilation:

cd bin
./exe

Input Files

The bin directory should contain:

• input.txt - Main configuration file
• m_user_data.f90 - User-defined functions for initial/boundary conditions

Example input.txt

# Mesh parameters
nx = 100
ny = 100
lx = 1000.0
ly = 1000.0

# Time parameters
dt = 0.1
t_end = 100.0

# Output parameters
output_frequency = 10
output_format = vtk

Parallel Execution

To run with MPI:

mpirun -np 4 ./exe

This will use 4 MPI processes for parallel computation.

Output Files

Results are written to /bin/res/ directory in the format specified in input.txt:

• VTK files: .vtk extension
• Tecplot files: .plt extension
• Binary files: .bin extension
• CSV files: .csv extension

Next Steps

• Initialization and Finalization - Learn about program lifecycle
• Inputs - Understand input file structure
• Outputs - Configure output files
• Mesh - Work with unstructured meshes