From cd739e1aeb51ce8ee43ea6e5024838efbef1ed69 Mon Sep 17 00:00:00 2001
From: Thomas Lambert <t.lambert@uliege.be>
Date: Thu, 22 Sep 2022 13:44:06 +0200
Subject: [PATCH] feat: use fixme, split style pkgs
---
.gitignore | 3 ++
contents/definitions.tex | 6 +--
contents/tech-solvers.tex | 8 ++-
contents/user-input.tex | 7 +--
rotare-doc.tex | 16 ++++--
style/commmmands.sty | 12 +++++
style/definitions.sty | 107 +++++++-------------------------------
style/symbols.sty | 81 +++++++++++++++++++++++++++++
8 files changed, 136 insertions(+), 104 deletions(-)
create mode 100644 style/commmmands.sty
create mode 100644 style/symbols.sty
diff --git a/.gitignore b/.gitignore
index 1dccda5..c3bf7bc 100644
--- a/.gitignore
+++ b/.gitignore
@@ -46,6 +46,9 @@
*.synctex.gz(busy)
*.pdfsync
+### List of fixmes (from fixme package)
+*.lox
+
### Ignore compiled pdfs
*.pdf
!figures/*/*.pdf
diff --git a/contents/definitions.tex b/contents/definitions.tex
index 49020c8..f1b274b 100644
--- a/contents/definitions.tex
+++ b/contents/definitions.tex
@@ -26,6 +26,6 @@
The following definitions are used through the whole manual. Some are also used
as configuration variables (see Chapter~\ref{chap:user:input}).
-% TODO: Add generic blade schematics
-% TODO: Add rotor disc and flow angle schematics
-% TODO: Add blade element schematic
+\todo{Add generic blade schematics}
+\todo{Add rotor disk and flow angles schematics}
+\todo{Add blade element schematics}
diff --git a/contents/tech-solvers.tex b/contents/tech-solvers.tex
index e787bc4..bd83c90 100644
--- a/contents/tech-solvers.tex
+++ b/contents/tech-solvers.tex
@@ -18,7 +18,6 @@
\label{chap:tech:solvers:BET}
Thrust, torque and power for the whole rotor:
-
\begin{align}
\label{eq:tech:solvers:BET:thrust}
\thrust &= \nBlades (d\lift \sin\indAngle - d\drag \cos\indAngle)\\
@@ -65,8 +64,8 @@ Likewise, the torque is given by
\label{chap:tech:solvers:solvers}
\rotare implements four different solvers, all of them based on the same set of
initial equations
-(see~\ref{eq:tech:solvers:BET:thrust}-\ref{eq:tech:solvers:BET:power} and \todo{ref
-for momentum eq}).
+(see~\ref{eq:tech:solvers:BET:thrust}-\ref{eq:tech:solvers:BET:power} and
+\todo{Ref for momentum eq}).
These solver differs by introducing some additional assumptions or by modifying
the nonlinear system of equations (mostly the momentum equations) in order to
@@ -74,8 +73,7 @@ simplify its formulation or the convergence of its solution.
\subsection{Leishman solver}
\label{chap:tech:solvers:leishman}
-This solver is based on the methodology described in \todo{cite: Leishman}.
-
+This solver is based on the methodology described in \fxcite
\subsection{Induction factor}
diff --git a/contents/user-input.tex b/contents/user-input.tex
index 93e1082..a52c6c8 100644
--- a/contents/user-input.tex
+++ b/contents/user-input.tex
@@ -161,7 +161,7 @@ Other miscellaneous parameters.
While they differ only from a factor 0.5, this can lead to difficulties when
comparing with existing experimental data.
- % TODO: Add notations
+ \todo{Add notations}
}
\describeOption{Sim.Misc.app}{}{\lst{'prop', 'heli', 'turbine'}}{
@@ -226,7 +226,8 @@ Numerical limits for the simulations.
}
\describeOption{Mod.Num.azimStep}{deg}{1}{
- Azimuthal step to use when simulating oblique flows. See~\todo{ref} for
+ Azimuthal step to use when simulating oblique flows. See
+ Chapter\fxnote{Chapter ref} for
details regarding oblique flow implementation.
\textit{The BEMT equations needs to be resolved for each azimuthal position of
@@ -248,7 +249,7 @@ The structure \lst{Flow} contains the parameters related to the flow itself.
Angle of the flow with respect to the direction perpendicular to the rotor
plane (\ie, 0$^\circ$ for axial flows).
- \todo{schematics}
+ \todo{Ref to schematics}
}
% ===============================================
diff --git a/rotare-doc.tex b/rotare-doc.tex
index 840817f..87596b5 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=false, % toggle if draft version
+draft, % toggle if draft version
]{scrreprt}%
@@ -74,6 +74,7 @@ draft=false, % toggle if draft version
bibsorting=nty,%
}{cleanthesis}
\usepackage{cleanthesis}
+\KOMAoptions{draft=false} % Get rid of rulers, keep the rest in draft mode
% Hyperref setup and pdf metadata
% ***********************************************
@@ -91,10 +92,12 @@ draft=false, % toggle if draft version
% Other additional packages
% ***********************************************
+\usepackage{definitions} % Custom definitions (see style/definitions.sty)
+\usepackage{symbols} % Custom definitions (see style/definitions.sty)
+\usepackage{commmmands} % Custom definitions (see style/definitions.sty)
\usepackage{ULiege-colors} % ULiege color theme
\usepackage{scrhack} % So other packages play nice with KOMA-Scripts
-\usepackage{definitions} % Custom definitions (see style/definitions.sty)
\usepackage[nolinks]{qrcode} % QR codes
\usepackage{booktabs} % Better looking tables
\usepackage{amsmath}
@@ -103,11 +106,15 @@ draft=false, % toggle if draft version
\usepackage[scale=2]{ccicons} % Icons for CC licenses
-\usepackage{import}
+% For inkscape figures
\usepackage{xifthen}
\usepackage{pdfpages}
\usepackage{transparent}
+\usepackage[inline, marginclue]{fixme}
+\fxsetup{theme=color}
+\newcommand\fxcite{\fxerror{Citation missing}}
+\newcommand{\todo}[1]{\fxnote{#1}}
% ==============================================================================
% COMMANDS AND ENVIRONMENTS
@@ -203,7 +210,8 @@ draft=false, % toggle if draft version
%\input{contents/changelog} % INCLUDE: appendix
\newpage
-\mbox{}
+\listoffixmes
+
% ==============================================================================
% END OF DOCUMENT
diff --git a/style/commmmands.sty b/style/commmmands.sty
new file mode 100644
index 0000000..59825d4
--- /dev/null
+++ b/style/commmmands.sty
@@ -0,0 +1,12 @@
+% -----------------------------------------------------------------------------
+% Definitions of custom commands to simplify the writing of this document.
+%
+% Author: Thomas Lambert <t.lambert@uliege.be>
+% ULiege - Aeroelasticity and Experimental Aerodynamics
+% CC0 License
+% https://gitlab.uliege.be/thlamb/rotare-doc
+% ------------------------------------------------------------------------------
+
+% --- Listings -----------------------------------------------------------------
+\newcommand\lst[1]{\lstinline[basicstyle=\ttfamily\normalsize]{#1}}
+\newcommand\lstmat[1]{\lstinline[language=matlab]{#1}}
diff --git a/style/definitions.sty b/style/definitions.sty
index 859d047..d9705b8 100644
--- a/style/definitions.sty
+++ b/style/definitions.sty
@@ -1,13 +1,15 @@
-% -----------------------------------------------------------------------------
-% List of definitions to ensure coherence in the notation between the abstract,
-% the paper and the presentation.
+% ------------------------------------------------------------------------------
+% Custom definitions and commands to simplify the writing of the document and
+% and ensure coherence in the style employed.
%
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
-% MIT License
-% https://gitlab.uliege.be/thlamb/bemt
+% CC0 License
+% https://gitlab.uliege.be/thlamb/rotare-doc
% ------------------------------------------------------------------------------
+% Packages required
+% ***********************************************
\RequirePackage{xspace}
\RequirePackage{fontawesome5}
\RequirePackage{xcolor}
@@ -19,26 +21,6 @@
\definecolor{myGreen}{RGB}{40,155,56}
\definecolor{myOrange}{RGB}{248,170,0}
-% --- Shortcuts ----------------------------------------------------------------
-\newcommand{\todo}[1]{\textcolor{red}{TODO: #1} \noindent}
-
-\newcommand{\latin}[1]{\textit{#1}}
-\newcommand{\ie}{\latin{i.e.},\xspace}
-\newcommand{\eg}{\latin{e.g.},\xspace}
-\newcommand{\etal}{\latin{et~al.}\xspace}
-
-\newcommand{\coderepoURL}{https://gitlab.uliege.be/thlamb/rotare}
-\newcommand{\codedocURL}{https://gitlab.uliege.be/thlamb/rotare-doc}
-
-\newcommand{\gV}{\textcolor{myGreen}{\faCheck}}
-\newcommand{\rX}{\textcolor{myRed}{\faTimes}}
-\newcommand{\yQ}{\textcolor{myOrange}{\faQuestion}}
-\newcommand{\oV}{\textcolor{myOrange}{\faCheck}}
-
-\newcommand{\danger}{\textcolor{myOrange}{\faExclamationTriangle}\xspace}
-
-\newcommand\lst[1]{\lstinline[basicstyle=\ttfamily\normalsize]{#1}}
-\newcommand\lstmat[1]{\lstinline[language=matlab]{#1}}
% --- Code & software names ----------------------------------------------------
\newcommand\rotare{\textsc{Rotare}\xspace}
@@ -49,6 +31,7 @@
\newcommand\AeroDyn{\textsc{AeroDyn}\xspace}
\newcommand\git{\textsf{git}\xspace}
+
% --- URLs ---------------------------------------------------------------------
\newcommand\rotareURL{https://gitlab.uliege.be/thlamb/rotare}
\newcommand\rotareReleaseURL{https://gitlab.uliege.be/thlamb/rotare/-/releases}
@@ -59,72 +42,18 @@
\newcommand\myEmail{\mbox{\textsf{t.lambert@uliege.be}}}
-% --- Velocities ---------------------------------------------------------------
-
-% Main velocities components
-\newcommand{\vAx}{\ensuremath{V}} % Absolute axial velocity
-\newcommand{\vTg}{\ensuremath{U}} % Absolute tangential velocity
-\newcommand{\rVel}{\ensuremath{W}} % Relative velocity
-
-% Induced velocities
-\newcommand\iAx[1][]{\ensuremath{v_{#1i}}} % Induced axial velocity
-\newcommand{\iTg}[1][]{\ensuremath{u_{#1i}}} % Induced tangential velocity
-
-
-\newcommand{\indSwirl}{\ensuremath{u_i}} % Swirl velocity, in-plane toward rot blade
-\newcommand{\indAxVel}{\ensuremath{v_i}} % Induced velocity, normal to rotor dis
-\newcommand{\airspeed}{\ensuremath{V_\infty}} % Freestream velocity
-\newcommand{\aVel}{\ensuremath{V}} % Axial velocity component
-\newcommand{\indAxWake}{\ensuremath{v_w}} % Slipstream velocity downstream
-\newcommand{\indSwirlWake}{\ensuremath{u_w}} % Slipstream velocity downstream
-\newcommand{\axFact}{\ensuremath{a}} % Axial induction factor
-\newcommand{\tgFact}{\ensuremath{b}} % Tangential induciton factor
-
-
-
-\newcommand{\angVel}{\ensuremath{\Omega}} % Angular velocity
-
-% --- Angles -------------------------------------------------------------------
-\newcommand{\sweep}{\ensuremath{\Lambda}} % Sweep
-\newcommand{\indAngle}{\ensuremath{\phi}} % Induced angle
-\newcommand{\aoa}{\ensuremath{\alpha}} % Angle of attack
-
-% --- Others -------------------------------------------------------------------
-\newcommand{\area}{\ensuremath{A}} % (Rotor) Area
-\newcommand{\radius}{\ensuremath{R}} % Rotor radius
-\newcommand{\rRad}{\ensuremath{r}} % Nondimensional radial position along the blade
-\newcommand{\aRad}{\ensuremath{y}} % Radial distance along the blade
-\newcommand{\advRat}{\ensuremath{\mathcal{J}}} % Advance ratio
-\newcommand{\mFlow}{\ensuremath{\dot{m}}} % Mass flow rate
+% --- Shortcuts ----------------------------------------------------------------
-\newcommand{\mach}{\ensuremath{\mathcal{M}}} % Mach number
-\newcommand{\reynolds}{\ensuremath{\mathcal{Re}}} % Reynolds number
-\newcommand{\dens}{\ensuremath{\rho}} % Density
-\newcommand{\nBlades}{\ensuremath{N_b}} % Number of blades
+\newcommand{\latin}[1]{\textit{#1}}
+\newcommand{\ie}{\latin{i.e.},\xspace}
+\newcommand{\eg}{\latin{e.g.},\xspace}
+\newcommand{\etal}{\latin{et~al.}\xspace}
-% --- Forces, torques, powers, etc ---------------------------------------------
+\newcommand{\gVsymb}{\textcolor{myGreen}{\faCheck}}
+\newcommand{\rXsymb}{\textcolor{myRed}{\faTimes}}
+\newcommand{\yQsymb}{\textcolor{myOrange}{\faQuestion}}
+\newcommand{\oVsymb}{\textcolor{myOrange}{\faCheck}}
-% Foces
-\newcommand{\lift}{\ensuremath{\mathcal{L}}} % Lift
-\newcommand{\drag}{\ensuremath{\mathcal{D}}} % Drag
-\newcommand{\thrust}{\ensuremath{\mathcal{T}}} % Thrust
-\newcommand{\torque}{\ensuremath{\mathcal{Q}}} % Torque
-\newcommand{\power}{\ensuremath{\mathcal{P}}} % Power
-\newcommand{\ForceX}{\ensuremath{F_x}} % Rotor force along X_TPP-axis
-\newcommand{\ForceY}{\ensuremath{F_y}} % Rotor force along Y_TPP-axis
-\newcommand{\MomX}{\ensuremath{M_x}} % Rotor moment along X_TPP-axis
-\newcommand{\MomY}{\ensuremath{M_y}} % Rotor moment along Y_TPP-axis
+\newcommand{\danger}{\textcolor{myOrange}{\faExclamationTriangle}\xspace}
-% Coefficients
-\newcommand{\cLift}{\ensuremath{c_l}} % Sectional lift coefficient
-\newcommand{\cLiftSlope}{\ensuremath{c_{l,\alpha}}} % Lift curve slope
-\newcommand{\cDrag}{\ensuremath{c_d}} % Sectional drag coefficient
-\newcommand{\cMom}{\ensuremath{c_m}} % Sectional moment coefficient coefficient
-\newcommand{\cThrust}{\ensuremath{C_{\thrust}}} % Thrust coefficient
-\newcommand{\cTorque}{\ensuremath{C_{\torque}}} % Torque coefficient
-\newcommand{\cPower}{\ensuremath{C_{\power}}} % Power coefficient
-\newcommand{\cForceX}{\ensuremath{C_{F_x}}} % Longitudinal force coefficient
-\newcommand{\cForceY}{\ensuremath{C_{F_y}}} % Lateral side force coefficient
-\newcommand{\cMomX}{\ensuremath{C_{M_x}}} % Rolling moment coefficient
-\newcommand{\cMomY}{\ensuremath{C_{M_y}}} % Pitching moment coefficient
diff --git a/style/symbols.sty b/style/symbols.sty
new file mode 100644
index 0000000..dfd3c4e
--- /dev/null
+++ b/style/symbols.sty
@@ -0,0 +1,81 @@
+% ------------------------------------------------------------------------------
+% Define mathematical symbols used for equations, definitions, figures, etc.
+% This ensures coherence between all parts of the document and simplifies
+% maintenance or changes in the nomenclature.
+%
+% Author: Thomas Lambert <t.lambert@uliege.be>
+% ULiege - Aeroelasticity and Experimental Aerodynamics
+% CC0 License
+% https://gitlab.uliege.be/thlamb/rotare-doc
+% ------------------------------------------------------------------------------
+
+
+% --- Velocities ---------------------------------------------------------------
+
+% Main velocities components
+\newcommand{\vAx}{\ensuremath{V}} % Absolute axial velocity
+\newcommand{\vTg}{\ensuremath{U}} % Absolute tangential velocity
+\newcommand{\rVel}{\ensuremath{W}} % Relative velocity
+
+% Induced velocities
+\newcommand\iAx[1][]{\ensuremath{v_{#1i}}} % Induced axial velocity
+\newcommand{\iTg}[1][]{\ensuremath{u_{#1i}}} % Induced tangential velocity
+
+
+\newcommand{\indSwirl}{\ensuremath{u_i}} % Swirl velocity, in-plane toward rot blade
+\newcommand{\indAxVel}{\ensuremath{v_i}} % Induced velocity, normal to rotor dis
+\newcommand{\airspeed}{\ensuremath{V_\infty}} % Freestream velocity
+\newcommand{\aVel}{\ensuremath{V}} % Axial velocity component
+\newcommand{\indAxWake}{\ensuremath{v_w}} % Slipstream velocity downstream
+\newcommand{\indSwirlWake}{\ensuremath{u_w}} % Slipstream velocity downstream
+\newcommand{\axFact}{\ensuremath{a}} % Axial induction factor
+\newcommand{\tgFact}{\ensuremath{b}} % Tangential induciton factor
+
+
+
+\newcommand{\angVel}{\ensuremath{\Omega}} % Angular velocity
+
+% --- Angles -------------------------------------------------------------------
+\newcommand{\sweep}{\ensuremath{\Lambda}} % Sweep
+\newcommand{\indAngle}{\ensuremath{\phi}} % Induced angle
+\newcommand{\aoa}{\ensuremath{\alpha}} % Angle of attack
+
+% --- Others -------------------------------------------------------------------
+\newcommand{\area}{\ensuremath{A}} % (Rotor) Area
+\newcommand{\radius}{\ensuremath{R}} % Rotor radius
+\newcommand{\rRad}{\ensuremath{r}} % Nondimensional radial position along the blade
+\newcommand{\aRad}{\ensuremath{y}} % Radial distance along the blade
+\newcommand{\advRat}{\ensuremath{\mathcal{J}}} % Advance ratio
+\newcommand{\mFlow}{\ensuremath{\dot{m}}} % Mass flow rate
+
+\newcommand{\mach}{\ensuremath{\mathcal{M}}} % Mach number
+\newcommand{\reynolds}{\ensuremath{\mathcal{Re}}} % Reynolds number
+\newcommand{\dens}{\ensuremath{\rho}} % Density
+\newcommand{\nBlades}{\ensuremath{N_b}} % Number of blades
+
+% --- Forces, torques, powers, etc ---------------------------------------------
+
+% Foces
+\newcommand{\lift}{\ensuremath{\mathcal{L}}} % Lift
+\newcommand{\drag}{\ensuremath{\mathcal{D}}} % Drag
+\newcommand{\thrust}{\ensuremath{\mathcal{T}}} % Thrust
+\newcommand{\torque}{\ensuremath{\mathcal{Q}}} % Torque
+\newcommand{\power}{\ensuremath{\mathcal{P}}} % Power
+\newcommand{\ForceX}{\ensuremath{F_x}} % Rotor force along X_TPP-axis
+\newcommand{\ForceY}{\ensuremath{F_y}} % Rotor force along Y_TPP-axis
+\newcommand{\MomX}{\ensuremath{M_x}} % Rotor moment along X_TPP-axis
+\newcommand{\MomY}{\ensuremath{M_y}} % Rotor moment along Y_TPP-axis
+
+% Coefficients
+\newcommand{\cLift}{\ensuremath{c_l}} % Sectional lift coefficient
+\newcommand{\cLiftSlope}{\ensuremath{c_{l,\alpha}}} % Lift curve slope
+\newcommand{\cDrag}{\ensuremath{c_d}} % Sectional drag coefficient
+\newcommand{\cMom}{\ensuremath{c_m}} % Sectional moment coefficient coefficient
+\newcommand{\cThrust}{\ensuremath{C_{\thrust}}} % Thrust coefficient
+\newcommand{\cTorque}{\ensuremath{C_{\torque}}} % Torque coefficient
+\newcommand{\cPower}{\ensuremath{C_{\power}}} % Power coefficient
+\newcommand{\cForceX}{\ensuremath{C_{F_x}}} % Longitudinal force coefficient
+\newcommand{\cForceY}{\ensuremath{C_{F_y}}} % Lateral side force coefficient
+\newcommand{\cMomX}{\ensuremath{C_{M_x}}} % Rolling moment coefficient
+\newcommand{\cMomY}{\ensuremath{C_{M_y}}} % Pitching moment coefficient
+
--
GitLab