---
myst:
    substitutions:
        macro:
            python: 1-5,17-30,33-38
            cpp: 4-6,13-19,22-27
        bloc1:
            python: "24"
            cpp: "15"
        console:
            python: 2-15
            cpp: 5-18
        sentence:
            python: "`sensitivtySobolFunctionFlowrate.py`"
            cpp: "`sensitivtySobolFunctionFlowrate.C`"
---
(use_cases_macro_sensitivity_sobol_reestimation)=
# Macro "**sensitivitySobolRe-estimation.{{extension}}**"

## Objective

The objective of this macro is to perform a full Sobol analysis using the existing file created when 
the Sobol class is allowed to perform the {{doe}} and the estimations by itself (see the first item 
in the tip box in [](#sensitivity_sobol_computation_indices) for more details). This would mean that 
the only computation done would be to estimate the coefficients (no external code / function called).

```{warning}
The `ref_sobol_launching_.dat` file used as input is not provided in the usual sub-directory 
*"/share/uranie/macros"* of the installation folder of {{uranie}} (*$URANIESYS*) but can be generated 
by the user by running the macro discussed in [](#use_cases_macro_sensitivity_sobol).
```

## Macro {{uranie}}

{{
    "```{" "literalinclude" "} " + parent_dir +
        "/roottest/uranie/doc/sensitivity/use_cases/" + language + "/sensitivitySobolReestimation." 
        + extension
    + "\n"
    + ":language: " + language + "\n"
    + ":lines: " + macro[language] + "\n"
    + "```"
}}
            
There are no external code or function to be run here. The input file `ref_sobol_launching_.dat` has 
to be generated by the use of {{sentence[language]}}. Once done it is loaded into the dataserver and 
the `TSobol` object is constructed from the simplest constructor with only the pointer to the dataserver, 
the input and output list:

{{
    "```{" "literalinclude" "} " + parent_dir +
        "/roottest/uranie/doc/sensitivity/use_cases/" + language + "/sensitivitySobolReestimation." 
        + extension
    + "\n"
    + ":language: " + language + "\n"
    + ":lines: " + bloc1[language] + "\n"
    + "```"
}}
            
Once done, the `computeIndexes()` method is called and few lines are shown to display the results in 
the classical plot form, leading to the figure below (it is provided to illustrate how to represent 
results). The numerical results are shown in the console below and are identical to the ones shown in 
[](#use_cases_macro_sensitivity_sobol_console) from where the full sample is coming from.

## Graph

The results of the previous macro is shown in {numref}`use_cases_sensitivitySobolRe-estimation`, 
where the evolution of the sobol coefficient is shown for all inputs with the uncertainty band, for 
the first order coefficient and the total one, respectively on the top and bottom panel.

{{
    "```{" "figure" "} " + parent_dir +
        "/roottest/build/uranie/doc/sensitivity/use_cases/" + language 
        + "/sobol_reestimation/sensitivitySobolReestimation.png\n"
    + ":align: center\n"
    + ":name: use_cases_sensitivitySobolRe-estimation\n"
    + figure_scale + "\n"
    + "\n"
    + "Graph of the macro **\"sensitivitySobolRe-estimation." + extension + "\"**" + "\n"
    + "```"
}}
            
## Console

{{
    "```{" "literalinclude" "} " + parent_dir +
        "/roottest/build/uranie/doc/sensitivity/use_cases/" + language + "/sensitivitySobolReestimation_clean.log"
    + "\n"
    + ":language: none\n"
    + ":lines: " + console[language] + "\n"
    + "```"
}}