From c44f7e72998b3f1b39e8cce9667106de77b68eee Mon Sep 17 00:00:00 2001
From: sunethwarna <suneth.warna@gmail.com>
Date: Thu, 1 Feb 2024 22:34:34 +0100
Subject: [PATCH] add response function docs

---
 .../Linear_Strain_Energy_Response_Function.md | 44 +++++++++++++++++++
 .../Responses/Mass_Response_Function.md       | 41 +++++++++++++++++
 .../Responses/menu_info.json                  |  5 +++
 3 files changed, 90 insertions(+)
 create mode 100644 docs/pages/Applications/Optimization_Application/Responses/Linear_Strain_Energy_Response_Function.md
 create mode 100644 docs/pages/Applications/Optimization_Application/Responses/Mass_Response_Function.md
 create mode 100644 docs/pages/Applications/Optimization_Application/Responses/menu_info.json

diff --git a/docs/pages/Applications/Optimization_Application/Responses/Linear_Strain_Energy_Response_Function.md b/docs/pages/Applications/Optimization_Application/Responses/Linear_Strain_Energy_Response_Function.md
new file mode 100644
index 000000000000..8867bb347707
--- /dev/null
+++ b/docs/pages/Applications/Optimization_Application/Responses/Linear_Strain_Energy_Response_Function.md
@@ -0,0 +1,44 @@
+---
+title: Linear Strain Energy Response Function
+keywords: 
+tags: [strain energy, response function, optimization]
+sidebar: optimization_application
+summary: 
+---
+## Introduction
+
+This computes the summation of strain energy from each element as the response value and its gradient.
+
+## Formulation
+
+Following formulation is used to compute the summation of strain energy from each element in the chosen model part where $$\underline{u}$$ is the displacement vector for the element and $$\mathbf{K}$$ is the stiffness matrix of the element.
+<p align="center">$$ J   = \frac{1}{2}\sum_{\forall \Omega_i \in \Omega} \underline{u}^T_i \mathbf{K}_i \underline{u}_i  $$</p>
+
+## Json settings
+Following code snippet illustrates json settings used in this response function.
+```json
+{
+    "name": "strain_energy",
+    "type": "linear_strain_energy_response_function",
+    "settings": {
+        "evaluated_model_part_names": [
+            "Structure"
+        ],
+        "primal_analysis_name": "Structure_static",
+        "perturbation_size": 1e-8
+    }
+}
+```
+
+| Option | Allowed values |
+| ------------- | ------------- |
+| name | A unique string |
+| type  | "linear_strain_energy_response_function"  |
+| evaluated_model_part_names  | List of model part names to compute strain energy |
+| primal_analysis_name | Name of the analysis from the list of analysis to be used for strain energy computation |
+| perturbation_size | Perturbation size to be used in the semi-analytic method |
+
+## Source files
+
+* [applications/OptimizationApplication/python_scripts/responses/linear_strain_energy_response_function.py](https://github.com/KratosMultiphysics/Kratos/blob/master/applications/OptimizationApplication/python_scripts/responses/linear_strain_energy_response_function.py)
+* [Doxygen](doxygen) TODO
diff --git a/docs/pages/Applications/Optimization_Application/Responses/Mass_Response_Function.md b/docs/pages/Applications/Optimization_Application/Responses/Mass_Response_Function.md
new file mode 100644
index 000000000000..48a5ee95e81b
--- /dev/null
+++ b/docs/pages/Applications/Optimization_Application/Responses/Mass_Response_Function.md
@@ -0,0 +1,41 @@
+---
+title: Mass Response Function
+keywords: 
+tags: [mass, response function, optimization]
+sidebar: optimization_application
+summary: 
+---
+
+## Introduction
+
+This response function computes the mass of the given list of model parts.
+
+## Formulation
+
+Following formulation is used.
+<p align="center">$$ J   = \sum_{\forall \Omega_i \in \Omega} m_i $$</p>
+
+## Json settings
+Following code snippet illustrates json settings used in this response function.
+```json
+{
+    "name": "mass",
+    "type": "mass_response_function",
+    "settings": {
+        "evaluated_model_part_names": [
+            "Structure"
+        ]
+    }
+}
+```
+
+| Option | Allowed values |
+| ------------- | ------------- |
+| name | A unique string |
+| type  | "mass_response_function"  |
+| evaluated_model_part_names  | List of model part names to compute mass |
+
+## Source files
+
+* [applications/OptimizationApplication/python_scripts/responses/mass_response_function.py](https://github.com/KratosMultiphysics/Kratos/blob/master/applications/OptimizationApplication/python_scripts/responses/mass_response_function.py)
+* [Doxygen](doxygen) TODO
\ No newline at end of file
diff --git a/docs/pages/Applications/Optimization_Application/Responses/menu_info.json b/docs/pages/Applications/Optimization_Application/Responses/menu_info.json
new file mode 100644
index 000000000000..0cc207564821
--- /dev/null
+++ b/docs/pages/Applications/Optimization_Application/Responses/menu_info.json
@@ -0,0 +1,5 @@
+{
+    "custom_entries": [
+        "Overview.md"
+    ]
+}
\ No newline at end of file