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
48e481e7
Verified
Commit
48e481e7
authored
2 years ago
by
Thomas Lambert
Browse files
Options
Downloads
Patches
Plain Diff
feat(usage): basic usage guide
parent
f4686193
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Pipeline
#8626
passed
2 years ago
Stage: build
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
contents/user-usage.tex
+29
-0
29 additions, 0 deletions
contents/user-usage.tex
with
29 additions
and
0 deletions
contents/user-usage.tex
+
29
−
0
View file @
48e481e7
...
...
@@ -12,3 +12,32 @@
\chapter
{
Usage
}
\label
{
chap:user:usage
}
\rotare
is fully controlled by a single input file, where the user specifies the
simulation parameters, the rotor geometry, the flow conditions, etc. See
Chapter~
\ref
{
chap:user:input
}
for details about this configuration file. In
theory this is the only place that requires user's attention.
First of all, make sure you are in the
\directory
{
rotare/src/
}
directory, or
that it is in
\matlab
's Path.
\rotare
can be called directly with a configuration file or without one. If no
configuration file is provided, the user will be prompted to select a
configuration file manually. This feature allows the user to call
\rotare
from
an other script and simplifies the interfacing between
\rotare
and other
scripts.
\bigskip
\begin{lstlisting}
[language=matlab]
% Manual selection of input file
rotare
% With a specific config file
rotare('configs/my
_
config.m')
\end{lstlisting}
\rotare
comes with a few test configs (a template file and some reproduction of
experimental results). You can verify that everything is working as intended by
running any of these files:
\begin{lstlisting}
[language=matlab]
rotare('configs/template.m')
\end{lstlisting}
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