Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Documentation
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Rotare
Documentation
Commits
ae69de92
Verified
Commit
ae69de92
authored
2 years ago
by
Thomas Lambert
Browse files
Options
Downloads
Patches
Plain Diff
doc(input): config validation
parent
1a141bb4
No related branches found
No related tags found
No related merge requests found
Pipeline
#7070
passed
2 years ago
Stage: build
Changes
3
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
contents/user-input.tex
+30
-1
30 additions, 1 deletion
contents/user-input.tex
doc-setup.tex
+1
-0
1 addition, 0 deletions
doc-setup.tex
style/definitions.sty
+49
-0
49 additions, 0 deletions
style/definitions.sty
with
80 additions
and
1 deletion
contents/user-input.tex
+
30
−
1
View file @
ae69de92
...
...
@@ -10,5 +10,34 @@
% International License (<https://creativecommons.org/licenses/by-sa/4.0/>)
% ------------------------------------------------------------------------------
\chapter
{
Input
file
}
\chapter
{
Configuration
file
}
\label
{
chap:user:input
}
A simulation with
\rotare
is controlled by a single configuration file. This
file contains all data related to the behavior of the software, the models and
solvers to use, the flow, the operating points to analyze and the rotor
geometry itself. These five types of input are collected inside five different
structures for easier handling in the code.
This input file should be a
\matlab
script (not a function). Examples of
configuration are given in src/config. In order to always have a fully-defined,
working configuration available, it is suggested to just copy the template and
edit your copy instead of directly working in the template.
\section
{
Input variables
}
\section
{
Configuration validation
}
Before initiating a simulation, the user input file is passed through a
validation function. This function checks if all inputs are properly defined and
formatted before starting the simulation. It also fixes small typos in the
string parameters whenever possible to ensure proper behavior of the software.
If the validation of a parameter fails, a comprehensive error message will be
returned. This should help the user to fix their issues easily.
The validation function will also return preliminary warnings whenever some
parameters may lead to potential issues. These warnings can easily be turned
off.
This diff is collapsed.
Click to expand it.
doc-setup.tex
+
1
−
0
View file @
ae69de92
...
...
@@ -82,3 +82,4 @@
% ==============================================================================
\usepackage
{
scrhack
}
% So other packages play nice with KOMA-Scripts
\usepackage
{
definitions
}
% Custom definitions (see style/definitions.sty)
This diff is collapsed.
Click to expand it.
style/definitions.sty
0 → 100644
+
49
−
0
View file @
ae69de92
% -----------------------------------------------------------------------------
% List of definitions to ensure coherence in the notation between the abstract,
% the paper and the presentation.
%
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
% MIT License
% https://gitlab.uliege.be/thlamb/bemt
% ------------------------------------------------------------------------------
\RequirePackage
{
xspace
}
\RequirePackage
{
fontawesome5
}
\RequirePackage
{
xcolor
}
% --- Better colors ------------------------------------------------------------
\definecolor
{
myRed
}{
RGB
}{
230,45,49
}
\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.
}}
\newcommand
{
\eg
}{
\latin
{
e.g.
}}
\newcommand
{
\etal
}{
\latin
{
et~al.
}
~
}
\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
}}
% --- Code & software names, ---------------------------------------------------
\newcommand\rotare
{
\textsc
{
Rotare
}
\xspace
}
\newcommand\matlab
{
\textsc
{
Matlab
}
\xspace
}
\newcommand\QBlade
{
\textsc
{
QBlade
}
\xspace
}
\newcommand\JBlade
{
\textsc
{
JBlade
}
\xspace
}
\newcommand\pyBEMT
{
\textsc
{
pyBEMT
}
\xspace
}
\newcommand\AeroDyn
{
\textsc
{
AeroDyn
}
\xspace
}
% --- Velocities ---------------------------------------------------------------
% --- Angles -------------------------------------------------------------------
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment