Commit e38c40d4 authored by Roland Gosda's avatar Roland Gosda
Browse files

Merge branch '10-add-caeses-files-for-the-example-applications' into 'master'

Resolve "Add CAESES files for the example applications"

Closes #10

See merge request !10
parents 2f1f259b ce36fedf
......@@ -71,13 +71,13 @@ Beware that the Boost library is usually linked dynamically. If you try to run a
Under Windows the library and the external libraries used are linked statically by default. If you choose to link dynamically, an additional step is required to be able to run a successfully build executable. On Windows the necessary dynamically linked libraries (DLLs) are usually not in the path. Therefore, the DLLs of HYKOPS and Boost-filesystem have to be placed in the path, e.g. the directory the executable is located in. To find out which exact DLLs are required, call `dumpbin.exe /dependents name_of_your_executable.exe` from a developer shell.
## Application Examples
There are example applications in `application_examples`. The examples show how a HYKOPS geometry can be im- and exported, how a propeller can be created from a set of parameters and how a propeller geometry from a PFF-geometry may be modified with parameters.
There are example applications in [application_examples](application_examples). The examples show how a HYKOPS geometry can be im- and exported, how a propeller can be created from a set of parameters and how a propeller geometry from a PFF-geometry may be modified with parameters.
### Exporting Geometries
In `export_hykops_geometry` a HYKOPS file is imported and the geometry is exported to external formats.
In [export_hykops_geometry](application_examples/export_hykops_geometry) a HYKOPS file is imported and the geometry is exported to external formats.
### Parametric Propeller
In `parametric_propeller` an executable is implemented, that creates a propeller with HYKOPS based on a set of parameters. Both a file describing the geometry based on HYKOPS and an IGES-file are created.
In [parametric_propeller](application_examples/parametric_propeller) an executable is implemented, that creates a propeller with HYKOPS based on a set of parameters. Both a file describing the geometry based on HYKOPS and an IGES-file are created.
### Modification of a Propeller
In `propeller_from_pff` a propeller, that is based on a PFF-file, is modified with HYKOPS beyond what is possible to describe with PFF. Both a file describing the geometry based on HYKOPS and an IGES-file are created.
In [propeller_from_pff](application_examples/propeller_from_pff) a propeller, that is based on a PFF-file, is modified with HYKOPS beyond what is possible to describe with PFF. Both a file describing the geometry based on HYKOPS and an IGES-file are created.
......@@ -3,6 +3,7 @@ This folder contains the source code for an executable that creates a propeller
In order to understand, how the parameters are set, a brief introduction into the mathematical functions used to describe a generic distribution of a parameter is given. Later the parameters are described.
### Compilation
To build the executable you may use the CMake build system. E.g. execute the following commands in a Linux terminal or Windows PowerShell
```
mkdir build
......@@ -10,7 +11,12 @@ cd build
cmake ..
cmake --build .
```
The scripts `run.sh` for Linux and `run.cmd` for Windows facilitates the call to the executable, as all parameters can be set in the script and the call to the executable is implemented in the script. Make sure the script is in the same directory the executable is located.
### Scripted Execution
The scripts [run.sh](run.sh) for Linux and [run.cmd](run.cmd) and [run.ps1](run.ps1) for Windows facilitates the call to the executable, as all parameters can be set in the script and the call to the executable is implemented in the script. Make sure the script is in the same directory the executable is located.
### CAESES Projects
Alternatively, you may run the application from the GUI in [CAESES](https://www.caeses.com/). Inside the folder [CAESES](CAESES) you may find CAESES projects for Linux and Windows based on this application example. Once you loaded the project in CAESES you have to specify the path of the executable in the variable `Executable`. Afterwards, you may change the parameters using predefined design varialbes inside the CAESES. The resulting geometry will be automatically displayed.
## Mathematical Structure of the Parameter Distributions
Let the relative radius of the loft path in a cylindrical coordinate system $`(r,\phi,z)`$ centered at the propeller origin with $`z`$ as the rotation axis be defined by
......
......@@ -3,6 +3,7 @@ This folder contains the source code for an executable that modifies a propeller
In order to understand, how the parameters are set, a brief introduction into the mathematical functions used to describe a generic distribution of a parameter is given. Later the parameters are described.
### Compilation
To build the executable you may use the CMake build system. E.g. execute the following commands in a Linux terminal or Windows PowerShell
```
mkdir build
......@@ -10,7 +11,12 @@ cd build
cmake ..
cmake --build .
```
The scripts `run.sh` for Linux and `run.cmd` for Windows facilitates the call to the executable, as all parameters can be set in the script and the call to the executable is implemented in the script. Make sure the script is in the same directory the executable is located.
### Scripted Execution
The scripts [run.sh](run.sh) for Linux and [run.cmd](run.cmd) and [run.ps1](run.ps1) for Windows facilitates the call to the executable, as all parameters can be set in the script and the call to the executable is implemented in the script. Make sure the script is in the same directory the executable is located.
### CAESES Projects
Alternatively, you may run the application from the GUI in [CAESES](https://www.caeses.com/). Inside the folder [CAESES](CAESES) you may find CAESES projects for Linux and Windows based on this application example. Once you loaded the project in CAESES you have to specify the paths of the executable in the variable `Executable` and of the PFF-file to modified in in the varialbe `PFF`. Afterwards, you may change the parameters using predefined design variables the CAESES. The resulting geometry will be automatically displayed.
## Mathematical Structure of the Parameter Distributions
Let the relative radius of the loft path in a cylindrical coordinate system $`(r,\phi,z)`$ centered at the propeller origin with $`z`$ as the rotation axis be defined by
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment