Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Optimization Application documentation #12003

Merged
merged 34 commits into from
Feb 9, 2024
Merged

[Docs] Optimization Application documentation #12003

merged 34 commits into from
Feb 9, 2024

Conversation

sunethwarna
Copy link
Member

@sunethwarna sunethwarna commented Feb 1, 2024

📝 Description
Finally log awaited documentation for the OptimizationApplication is here. This PR adds docs for almost all the components docs with examples.

🆕 Changelog

  • Adds documentation for OptimizationApplication

FYI: @adityabodas

@sunethwarna sunethwarna marked this pull request as ready for review February 2, 2024 12:22
* [Doxygen](TODO) TODO
* [applications/OptimizationApplication/custom_utilities/filtering/filter_function.h](https://github.com/KratosMultiphysics/Kratos/blob/master/applications/OptimizationApplication/custom_utilities/filtering/filter_function.h)
* [applications/OptimizationApplication/custom_utilities/filtering/damping_function.h](https://github.com/KratosMultiphysics/Kratos/blob/master/applications/OptimizationApplication/custom_utilities/filtering/damping_function.h)
* [applications/OptimizationApplication/custom_utilities/filtering/explicit_filter.h](https://github.com/KratosMultiphysics/Kratos/blob/master/applications/OptimizationApplication/custom_utilities/filtering/explicit_filter.h)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can add ref. to some our papers about VM, from Bletzinger, Reza and etc.

Copy link
Member

@Igarizza Igarizza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't went through the files. Mostly checked the main overview sentence. In general it is fine but definitely not ideal.


## Introduction

```Control``` is used to regularize the design variables updates, which are given by the ```Algorithm``` as illustrated in Figure 1. It also updates the properties of the ```model_part```. This is also used to transform data between physical and control spaces.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```Control``` is used to regularize the design variables updates, which are given by the ```Algorithm``` as illustrated in Figure 1. It also updates the properties of the ```model_part```. This is also used to transform data between physical and control spaces.
```Control``` is used to regularize the design variables updates, which are given by the ```Algorithm``` as illustrated in Figure 1. It also updates the properties of the ```model_part```., meaning transforming data between physical parameters and control variables.

@sunethwarna
Copy link
Member Author

Thanks @Igarizza . We have to check these one by one later.

@sunethwarna sunethwarna merged commit 83aaabc into master Feb 9, 2024
15 of 19 checks passed
@sunethwarna sunethwarna deleted the docs/optapp branch February 9, 2024 00:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants