feelpp / book.feelpp.org Goto Github PK

:globe_with_meridians: The Feel++ Book

License: GNU General Public License v3.0

Makefile 1.37% TeX 12.31% Shell 0.73% Dockerfile 0.51% Jupyter Notebook 85.07%

feelpp finite-elements fem book user-manual developer-manual toolbox-manual contributor-manual tutorial mathematical-framework

book.feelpp.org's Introduction

Feel++: Finite Element Embedded Library in C++

Table of Contents

What is Feel++ ?
Read the Feel++ Book
Help and Support
Contribute to this documentation
Generating the website

What is Feel++ ?

Feel++ is a unified C++ implementation of Galerkin methods (finite and spectral element methods) in 1D, 2D and 3D to solve partial differential equations.

Feel++ is

a versatile mathematical kernel solving easily problems using different techniques thus allowing testing and comparing methods, e.g. cG versus dG.
a small and manageable library which nevertheless encompasses a wide range of numerical methods and techniques and in particular reduced order methods such as the reduced basis method.
a software that follows closely the mathematical abstractions associated with partial differential equations (PDE) and in particular the finite element mathematical framework and variational formulations.
a library that offers solving strategies that scales up to thousands and even tens of thousands of cores.
a library entirely in C++ allowing to create C++ complex and typically non-linear multi-physics applications currently in industry, physics and health-care.

Read the Feel++ Book

All the Feel++ manuals are available at http://book.feelpp.org.

Help and Support

We’re always happy to help out with Feel++ or any other questions you might have. You can ask a question or signal an issue at the Gitter Feel++ salon.

Contribute to this documentation

You can contribute to improve this documentation on GitHub.

Generating the website

Feel++ uses Antora to generate the website http://docs.feelpp.org.

❗	Prerequisites : npm, curl You can install these dependencies on Ubuntu/Debian OS by executing : sudo apt install npm curl

Once you have installed prerequisites, follow the next steps to generate a local preview of the website http://docs.feelpp.org.

git clone https://github.com/feelpp/book.feelpp.org.git # (1)
git clone https://github.com/feelpp/toolbox.git # (2)
cd book.feelpp.org # (3)
npm install # (4)
npm run dev # (5)
npm run serve # (6)

clone the source for the website
clone the source for toolbox cases doc
go the toplevel directory
install antora and some other dependencies
build a local preview of the website with Antora
start the node.js webserver serve, see the docs.

book.feelpp.org's People

Contributors

Stargazers

Watchers

book.feelpp.org's Issues

Add new application in toolbox/csm in book.feelpp.org

We have now new application thanks to SZE students and @lotfiAb. The examples should be added to be book.feelpp.org automatically thanks to asciidoc include::

the examples are in https://github.com/feelpp/toolbox

Feature/antora

The PR provides an entirely new framework for our documentation. It is based on Antora .
It implements:

#53 review/update dev manual
#52 add angiotk manual
#51 documentation for data mangement plan
#50 journaling and benchmarking documentation
#49 the documentation for alsacalcul
#48 a review of the user manual
#47 re-design the architecture to fit Antora design
#45 new toolbox examples and benchmarks from http://github.com/feelpp/toolbox
#44 basic documentation for toolbox usage
#43 math fixes in dev man for algebraic solutions

Create several schemes to describe infrasctruture, deployment...

update documentation after update of feelpp-env

Now feelpp-env incorporates tools to

make a release automatically of feel++ using various tools (curl, jq, github_changelog_generator...)
asciidoctor tools suite for book.feelpp.org

We could probably have the book install in a docker image very soon

move book architecture to antora

Context

book.feelpp.org is based currently on Jekyll and Asciidoc. Antora has been developed and provides a nice framework to document code using Asciidoc.
After a few tests, it is clear that it is the way to go for our documentation.

Architecture

Antora has a flexible architecture described here.

I propose that we split book into several manuals as currently done on the website and reorganize ala antora. We would have

User Manual
Developer Manual
The Mathematics of Feel++ (we merge fem, anafunc, rb and hdg)
Feel++ Toolboxes Manual
Infrastructure manual (Atlas, Mesocentre, ...)

/cc @feelpp/mso4sc

The formula is still in Latex

http://book.feelpp.org/toolbox/maxwell/#Strategy

Part 4.2

Add AntgioTK user manual to Feel++ book

AngioTK is a software toolchain to reconstruct vessels from MRI images. It uses Feel++ toolboxes as well as some low level features such as the configuration file system.
AngioTK should be added to Feel++ book

/cc @vincentchabannes @francoisdh @metivett

Feature/antora

The PR provides an entirely new framework for our documentation. It is based on Antora .
It implements:

#53 review/update dev manual
#52 add angiotk manual
#51 documentation for data mangement plan
#50 journaling and benchmarking documentation
#49 the documentation for alsacalcul
#48 a review of the user manual
#47 re-design the architecture to fit Antora design
#45 new toolbox examples and benchmarks from http://github.com/feelpp/toolbox
#44 basic documentation for toolbox usage
#43 math fixes in dev man for algebraic solutions

Documentation FSI

I can't find the FSI toolbox documentation explaining the various possible options that one can choose, (neither in books nor in docs)

Add documentation for singularity

Provide documentation for Feel++ singularity images

how to download
how to run applications
provides examples for sequential and parallel applications

Cover not showing in book.feelpp.org/math

it seems that the list of math books in book.feelpp.org/math is not showing up properly

Add postprocessing section documentation

We should add a section to explain how to post process data with feel++ (basics, + ref to paraview, gmsh, ... doc)

In particular, how to use

paraview Insitu with feel++
paraview pvserver
paraweb (later)
gmsh

etc...

Review User Manual

review the user manual and proposes fixes, modifications, additions...
http://docs.feelpp.org/user/0.1/index.html

Does it answer basic questions about Feel++?
Does it provide proper installation procedures?
Does it provide basic examples?
Does it enable a quick start with Feel++? (within 1 hour counting software download)

Typing mistake & broken link

In user manual , 12.9 Strong Formulation, I think integral signs have to be removed in the second equation.
Also, the link in 12.7 to advanced informations about function spaces seems to be broken.

CRB Chapter Linear Parabolic Problems

Add CmakeLists.txt template

Looking at the minimal example there is no cmake file example, unless I'm mistaken.

Maybe we should add the following:

cmake_minimum_required(VERSION 2.8)

if ( ${CMAKE_MAJOR_VERSION} EQUAL 3 AND ${CMAKE_MINOR_VERSION} GREATER 3 )
  message(STATUS "[feelpp] use OLD policy CMP0064" )
  cmake_policy(SET CMP0064 OLD)
endif()

project(minimalexample)
set(PROJECT_SHORTNAME "me")

if ( ${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_CURRENT_SOURCE_DIR} )
 find_package(Feel++ PATHS $ENV{FEELPP_DIR}/share/feelpp/feel/cmake/modules /usr/share/feelpp/feel/cmake/modules /usr/local/share/feelpp/feel/cmake/modules ) 
 if(NOT FEELPP_FOUND)
      message(FATAL_ERROR "Feel++ was not found on your system. Make sure to install it and specify the FEELPP_DIR to reference the installation directory.")
  endif()
endif()

include_directories(${CMAKE_CURRENT_SOURCE_DIR})
include_directories(${CMAKE_CURRENT_BINARY_DIR})

feelpp_add_application( myapp SRCS myapp.cpp CFG myapp.cfg )

Add ADR, Stokes and Elasticity examples

There is addition of the ADR, Stokes and Elasticity examples to be added to the math manual and incorporated into the user manual in the learn by example section.

the Laplacian example should be most to the math manual to be consistent

Add documentation to use Feel++ Alsacalcul

It is now strategic to document the use of Feel++ on Alsacalcul and verify that Feel++/singularity is working there properly.

We would like to provide Feel++ services on Alsacalcul first the standard way, then the MSO4SC way once it is stable enough

/cc @vincentchabannes @gdolle

Document Feel++ data management plan

The Feel++ data management needs to be documented and should be available online in the feelpp books/docs.

A first idea: create a module that should appear in the user, dev and toolbox manuals and contain the overall strategy.
A second idea: split the management plan between user, dev and toolbox manuals

what do you think?
I would prefer a overall picture in one module

review and update dev manual

The dev manual is currently in a sorry state and split in non-comprehensive structure.
it needs a major overhaul

Create a functional analysis book

All the functional analysis theory should go in one book for

finite element method
reduced basis method
hybridized discontinuous Galerking method

and more...

Missing link on Feel++ book on how to Compile Boost C++ library

@lberti commented on Mon Apr 09 2018

I was trying to install Feel++ in my computer but it's Ubuntu 16.04 and it has the following problem, already reported in the webpage. The link on how to recompile Boost is not working.

"We are unfortunately stung by the ABI change in GCC 6 when using clang. You need to recompile the Boost C++ libraries to be able to use clang, see the section in the Annexes on Compiling Boost."

@gdolle commented on Mon Apr 09 2018

Hi @lberti,

Here you have the documentation on how to compile boost,
https://www.boost.org/doc/libs/1_66_0/more/getting_started/unix-variants.html

you can have a look at how we build boost for Feel++ on our ubuntu-16.04 docker images:
https://github.com/feelpp/docker/blob/2b53fc9ab1a730327b6f52ed4d06e691d6d36cc8/feelpp-env/Dockerfile-boost

Currently this issue is documentation related, I move this issue in the appropriate repository and close this one.

NB: We are currently moving/updating the documentation to this http://docs.feelpp.org don't hesitate to give us feedback.

CRB Chapter Linear Elliptic Problems

Bool missing files

@prudhomm it seems there the file math/fem/macros.tex is missing and the stylesheet (for index.html, stylesheets/custom.css) seems not up to date, I'have blank background from my side

Add documentation of basic toolbox usage

Add in book.feelpp.org and book.mso4sc CSM toolbox usage, eg torsionbar ?
use include in order to deploy on book.mso4sc
describe

model
expected results
expected performance

This is necessary for the MSO4SC project to verify and validate that the application that we run, are indeed running properly

Link problem in user manual

http://book.feelpp.org/user-manual/#output_directories

a .adoc extension appears

Add explainations to use createSubmesh

Would it be possible to have some details to use createSubmesh ?

@prudhomm @vincentchabannes

CRB Chapter NonLinear Elliptic Problems

Add documentation for creating a new multiphysic application using existing mono/multi physics models

We should add some documentation for creating a new multiphysic application using existing mono/multi physics models in the book.
We can start a simple document to start and then see where to add it later in the Programming book

Add page on Feel++ installation on supercomputer !

tentative title : Feel++ for HPC centers

Atlas port
Strasbourg Mesocentre

CRB Chapter Introduction

Create a solution strategy book

We should have a book on

linear and non-linear systems solution
preconditioning
domain decomposition methods

Feature/antora

The PR provides an entirely new framework for our documentation. It is based on Antora .
It implements:

#53 review/update dev manual
#52 add angiotk manual
#51 documentation for data mangement plan
#50 journaling and benchmarking documentation
#49 the documentation for alsacalcul
#48 a review of the user manual
#47 re-design the architecture to fit Antora design
#45 new toolbox examples and benchmarks from http://github.com/feelpp/toolbox
#44 basic documentation for toolbox usage
#43 math fixes in dev man for algebraic solutions

add CI/CD support

use buildkite to build and deploy the website

Provide various version of the manuals cover image

Feel++ User Manual
Feel++ Programming Manual
Feel++ FEM Manual
Feel++ HDG Manual
Feel++ RBM Manual

wouk it be possible to do it by script ?

fud5 wrong sept11 presentation path

@Trophime

review and update dev manual

The dev manual is currently in a sorry state and split in non-comprehensive structure.
it needs a major overhaul

review and update dev manual

The dev manual is currently in a sorry state and split in non-comprehensive structure.
it needs a major overhaul

Add images for HDG toolboxes

List the hdg toolboxes and present them like the other toolboxes

Add reduced basis documentation

We have now feelpp/feelpp#843 in good shape, all the codes are compiling. We have to add some documentation

Create a CRB Book

Feature/antora

The PR provides an entirely new framework for our documentation. It is based on Antora .
It implements:

#53 review/update dev manual
#52 add angiotk manual
#51 documentation for data mangement plan
#50 journaling and benchmarking documentation
#49 the documentation for alsacalcul
#48 a review of the user manual
#47 re-design the architecture to fit Antora design
#45 new toolbox examples and benchmarks from http://github.com/feelpp/toolbox
#44 basic documentation for toolbox usage
#43 math fixes in dev man for algebraic solutions

Document usage of Exporter including within loops

We should document the way Exporter should be used within loops (eg time loops)

For example writing this in a loop

    auto e = exporter( _mesh=mesh );
    e->addRegions();
    e->step(t)->add( "u", u );
    e->step(t)->add( "p", p );
    e->save();

at time t would overwrite results at previous time steps.
It should have written this way instead.

auto e = exporter( _mesh=mesh );
for( double t = dt; t < T; t += dt )
{
    // do stuff with u and p
    e->step(t)->add( "u", u );
    e->step(t)->add( "p", p );
    e->save();
}

Feature/antora

The PR provides an entirely new framework for our documentation. It is based on Antora .
It implements:

#53 review/update dev manual
#52 add angiotk manual
#51 documentation for data mangement plan
#50 journaling and benchmarking documentation
#49 the documentation for alsacalcul
#48 a review of the user manual
#47 re-design the architecture to fit Antora design
#45 new toolbox examples and benchmarks from http://github.com/feelpp/toolbox
#44 basic documentation for toolbox usage
#43 math fixes in dev man for algebraic solutions

Feature/antora

The PR provides an entirely new framework for our documentation. It is based on Antora .
It implements:

#53 review/update dev manual
#52 add angiotk manual
#51 documentation for data mangement plan
#50 journaling and benchmarking documentation
#49 the documentation for alsacalcul
#48 a review of the user manual
#47 re-design the architecture to fit Antora design
#45 new toolbox examples and benchmarks from http://github.com/feelpp/toolbox
#44 basic documentation for toolbox usage
#43 math fixes in dev man for algebraic solutions

Feature/antora

The PR provides an entirely new framework for our documentation. It is based on Antora .
It implements:

#53 review/update dev manual
#52 add angiotk manual
#51 documentation for data mangement plan
#50 journaling and benchmarking documentation
#49 the documentation for alsacalcul
#48 a review of the user manual
#47 re-design the architecture to fit Antora design
#45 new toolbox examples and benchmarks from http://github.com/feelpp/toolbox
#44 basic documentation for toolbox usage
#43 math fixes in dev man for algebraic solutions

Feature/antora

The PR provides an entirely new framework for our documentation. It is based on Antora .
It implements:

#53 review/update dev manual
#52 add angiotk manual
#51 documentation for data mangement plan
#50 journaling and benchmarking documentation
#49 the documentation for alsacalcul
#48 a review of the user manual
#47 re-design the architecture to fit Antora design
#45 new toolbox examples and benchmarks from http://github.com/feelpp/toolbox
#44 basic documentation for toolbox usage
#43 math fixes in dev man for algebraic solutions

CRB Chapter EIM

review and update dev manual

The dev manual is currently in a sorry state and split in non-comprehensive structure.
it needs a major overhaul

Add journaling/benchmarking documentation

it would be nice to have the description of the benchmark framework in the dev manual http://docs.feelpp.org/dev/0.1 (a new module of course). We could have also a section also in the user manual to explain how to produce the Feel++ simulation journal

feelpp / book.feelpp.org Goto Github PK

book.feelpp.org's Introduction

Feel++: Finite Element Embedded Library in C++

What is Feel++ ?

Read the Feel++ Book

Help and Support

Contribute to this documentation

Generating the website

book.feelpp.org's People

Contributors

Stargazers

Watchers

Forkers

book.feelpp.org's Issues

Context

Architecture

Recommend Projects

Recommend Topics

Recommend Org

Jobs