Basilisk Documentation

This is a Documentation for PDE solver Basilisk written by Haochen Huang, a master candidate in XJTU.

The doc is written for those who are interested in how things work inside Basilisk and want to alter the solver.

For Real What is Basilisk?

Technically, Basilisk consists of two parts.

Unlike most of the opensourced solver which is indeed a group of header file that can solve a specific type of PDE written in Fortran/C/C++, Basilisk also provides a kind of programme language ( a compiler specifically ) named BasiliskC. For those who have experience of simulation with Basilisk, the installation process is the process generating qcc: the complier provided by Basilisk.

Therefore a coherent documentation for Basilisk should be twofolds. The first part is the header file, including the solver, the configuration of mesh etc. And the second part is the compiler as well as the design philosophy behind (in my limited personal perspective of course).

Plan

Header File

Incompressible solver

• [] centered solver

  • [] centered.h
  • [] double-projection.h
    • viscosity.h
    • poisson.h
    • bcg.h

• [] VOF multiphase solver

  • [] two-phase-levelset.h
    • [] redistance.h
  • [] two-phase-clsvof.h
    • [] tracer.h
  • [] two-phase.h
    • [] two-phase-generic.h
    • vof.h
      • [] fractions.h
      • [] geometry.h
  • [] iforce.h
    • [] curvature.h
      • [] heights.h
      • [] parabola.h

• [] solid embed boundary

  • [] embed.h and everything associated in other headfile
  • [] embed-tree.h

Compressible solver

• [] compressible

Future maybe

• [] mesh associated

Compiler

• [] ast

Contact

My sandbox and feel free to email me: [email protected]