diff --git a/contents/tech-intro.tex b/contents/tech-intro.tex new file mode 100644 index 0000000000000000000000000000000000000000..e15b563f83341585f05ac928482cab611954aa15 --- /dev/null +++ b/contents/tech-intro.tex @@ -0,0 +1,26 @@ +% ----------------------------------------------------------------------------- +% Introduction of the technical documentation +% +% Author: Thomas Lambert <t.lambert@uliege.be> +% ULiege - Aeroelasticity and Experimental Aerodynamics +% https://gitlab.uliege.be/thlamb/Rotare-doc +% +% License: CC-BY-SA-4.0 +% This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 +% International License (https://creativecommons.org/licenses/by-sa/4.0/) +% ------------------------------------------------------------------------------ + +\chapter*{Introduction} +\label{chap:tech:intro} + +This second part of \rotare's documentation concerns the technical aspect of +the code and its implementation. The goal is not to give a full lecture on the +Blade Element Momentum Theory, but rather to write out the main equations and +detail the way they are implemented and solved within \rotare. + +The first chapter details the architecture of the code itself, which can be +useful if the developers that want to extend the possibilities offered by the +software. +The following ones are more directed to users that want an in-depth knowledge of +the equations and solving process employed by the program. Finally, some basic +validation cases are provided against well-known literature examples. diff --git a/rotare-doc.tex b/rotare-doc.tex index fa2ec5040531e561c48416cec8b58aecec056ef4..a802b20904c926dfcdba08d4111f7353f1922392 100644 --- a/rotare-doc.tex +++ b/rotare-doc.tex @@ -25,7 +25,7 @@ titlepage=on, % own page for each title page captions=tableabove, % display table captions above the float env chapterprefix=false, % do not display a prefix for chapters appendixprefix=false, % do not display a prefix for appendix chapter -draft, % toggle if draft version +%draft, % toggle if draft version ]{scrreprt}% @@ -85,7 +85,7 @@ draft, % toggle if draft version \part{Technical documentation} \label{part:tech} -\input{contents/definitions} +\input{contents/tech-intro} %\input{contents/tech-architecture} \input{contents/tech-solvers} \input{contents/tech-extensions}