Welcome to Tug’s documentation!
Welcome to the documentation of the TUG project, a simulation program for solving transport equations in one- and two-dimensional uniform grids using cell centered finite differences.
Diffusion
TUG can solve diffusion problems with heterogeneous and anisotropic diffusion coefficients. The partial differential equation expressing diffusion reads:
\[\frac{\partial C}{\partial t} = \nabla \cdot \left[ \mathbf{\alpha} \nabla C \right]\]
In 2D, the equation reads:
\[\frac{\partial C}{\partial t} = \frac{\partial}{\partial x}\left[ \alpha_x \frac{\partial C}{\partial x}\right] + \frac{\partial}{\partial y}\left[ \alpha_y \frac{\partial C}{\partial y}\right]\]
Indices and tables
- Welcome to Tug’s documentation!
- Installation
- Theoretical Foundations
- User API
- Grid
Grid
Grid::Grid()
Grid::Grid()
Grid::setConcentrations()
Grid::getConcentrations()
Grid::setAlpha()
Grid::setAlpha()
Grid::getAlpha()
Grid::getAlphaX()
Grid::getAlphaY()
Grid::getDim()
Grid::getLength()
Grid::getRow()
Grid::getCol()
Grid::setDomain()
Grid::setDomain()
Grid::getDelta()
Grid::getDeltaCol()
Grid::getDeltaRow()
- Boundary
BC_TYPE
BC_SIDE
Boundary
Boundary::Boundary()
Boundary::Boundary()
Boundary::Boundary()
Boundary::setBoundarySideClosed()
Boundary::setBoundarySideConstant()
Boundary::setBoundaryElemenClosed()
Boundary::setBoundaryElementConstant()
Boundary::getBoundarySide()
Boundary::getBoundarySideValues()
Boundary::getBoundaryElement()
Boundary::getBoundaryElementType()
Boundary::getBoundaryElementValue()
Boundary::serialize()
Boundary::deserialize()
Boundary::setInnerBoundary()
Boundary::setInnerBoundary()
Boundary::getInnerBoundary()
Boundary::getInnerBoundary()
Boundary::getInnerBoundaryRow()
Boundary::getInnerBoundaryCol()
Boundary::getInnerBoundaries()
Boundary::setInnerBoundaries()
BoundaryElement
- Simulation
APPROACH
SOLVER
CSV_OUTPUT
CONSOLE_OUTPUT
TIME_MEASURE
Simulation
Simulation::Simulation()
Simulation::setOutputCSV()
Simulation::setOutputConsole()
Simulation::setTimeMeasure()
Simulation::setTimestep()
Simulation::getTimestep()
Simulation::setIterations()
Simulation::setNumberThreads()
Simulation::getIterations()
Simulation::printConcentrationsConsole()
Simulation::createCSVfile()
Simulation::printConcentrationsCSV()
Simulation::run()
- Grid
- Developer Guide
- Examples
- Visualization
- Contributors