Documentation

• Wiki
• User Guide (work in progress…)
• Developer Guide
• Distributed examples

Quick Start

Installation

1. Install cmake (>=3.0.2, BSD License) and the required libraries:
   • OpenCL (>=1.2, OpenCL Specification License); open or closed source implementation, see deployment information
   • boost (>=1.53, Boost Software License)
   • VTK (>=6.1, BSD License)
   • optional: Matlab support with matio (>=1.5.2, BSD License)
   • optional: API documentation with doxygen (preferably with graphviz)
2. Download and extract the ASL source code archive.
3. Create a build directory: mkdir build-asl && cd build-asl
4. Use cmake generator to produce Makefiles: cmake -G "Unix Makefiles" ../ASL or project files for your IDE (Visual Studio, Xcode, Eclipse, etc.): cmake -G "Visual Studio 10" ../ASL
5. Run make (as root if installing into default destination /usr/local): make install

Running an example

1. Go to examples: cd examples/flow/locomotive
2. Download geometry file locomotive.stl from the ASL input data page.
3. Run: ./asl-locomotive --input locomotive.stl
   Optionally: change parameters ./asl-locomotive --input locomotive.stl --dx 1 --dt 2 or write all of them into a file for later editing/reuse - ./asl-locomotive -g bigGrid.ini. List all available options - ./asl-locomotive -h.
4. Post-processing: see step by step example and locomotive.pvsm - the ParaView state file.

Writing your own code using ASL

1. Take a look on examples and the API documentation, start with examples/flow/locomotive.cc
2. ASL installation supplies ASL.pc and ASLConfig.cmake files. To build your program using:

• pkg-config: c++ `pkg-config --cflags --libs ASL` -std=c++11 -o flow flow.cc
• cmake: write a basic CMakeLists.txt file:

project(locomotive)
cmake_minimum_required(VERSION 3.0.2 FATAL_ERROR)
find_package(ASL 0.1.4 CONFIG REQUIRED)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
add_executable(locomotive locomotive.cc)
target_link_libraries(locomotive PRIVATE ASL::aslnum ASL::aslvtk ASL::asl)