Skip to content

Commit

Permalink
Deploying to gh-pages from @ 584a179 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
marchdf committed Jan 22, 2024
1 parent 5d7d44f commit ba92ca2
Show file tree
Hide file tree
Showing 1,582 changed files with 49,067 additions and 38,897 deletions.
101 changes: 57 additions & 44 deletions _sources/user/inputs_ABL.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,97 +6,97 @@ This section is for setting atmospheric boundary layer parameters.
.. input_param:: ABL.kappa

**type:** Real, optional, default = 0.41

Wall model coefficient.

.. input_param:: ABL.surface_roughness_z0

**type:** Real, optional, default = 0.1
Wall model surface roughness.

Wall model surface roughness.

.. input_param:: ABL.normal_direction

**type:** Integer, optional, default = 2

Wall model normal direction. x-direction = 0, y-direction = 1, z-direction = 2.

.. input_param:: ABL.log_law_height

**type:** Real, optional
Height to evaluate the log law for the wall model.

Height to evaluate the log law for the wall model.
Currently, if this parameter is not specified in the input file, the first half cell height is calculated
and is used to set the log law height.
Therefore the log law height depends on the domain size and number of elements in the normal direction.
If this parameter is set to a number the log law is evaluated at a fixed height.
Note: currently the fluctuating velocity terms in the shear stress model are only
and is used to set the log law height.
Therefore the log law height depends on the domain size and number of elements in the normal direction.
If this parameter is set to a number the log law is evaluated at a fixed height.
Note: currently the fluctuating velocity terms in the shear stress model are only
available at the first cell center above the wall. This limitation will be removed soon.


.. input_param:: ABL.temperature_heights

**type:** List of Reals, mandatory
Height(s) in meters at which temperature values are prescribed.
**type:** List of Reals, mandatory

Height(s) in meters at which temperature values are prescribed.

.. input_param:: ABL.temperature_values

**type:** List of Reals (has to be same length as :input_param:`ABL.temperature_heights`), mandatory

Temperature values in Kelvin at the corresponding :input_param:`ABL.temperature_heights`.
The temperature below the first height is assumed to be constant and equal to the
first temperature value.
The temperature between values is initialized to have linear variation.
The final temperature is constant above the last specified height.
first temperature value.
The temperature between values is initialized to have linear variation.
The final temperature is constant above the last specified height.


.. input_param:: ABL.perturb_velocity

**type:** Boolean, optional, default = true
If true this flag turns on perturbations to the freestream flow.

If true this flag turns on perturbations to the freestream flow.

.. input_param:: ABL.pertub_ref_height

**type:** Real, optional, default = 50.0
Reference height for velocity perturbations,

Reference height for velocity perturbations,
perturbations exist below this height and decay above this height.
Only active when :input_param:`ABL.perturb_velocity` = true.

.. input_param:: ABL.Uperiods

**type:** Real, optional, default = 4.0

Number of sinusoidal waves in x-direction.
Only active when :input_param:`ABL.perturb_velocity` = true.

.. input_param:: ABL.Vperiods

**type:** Real, optional, default = 4.0

Number of sinusoidal waves in y-direction.
Only active when :input_param:`ABL.perturb_velocity` = true.

.. input_param:: ABL.deltaU

**type:** Real, optional, default = 1.0

Amplitude of fluctuations in x-direction.
Only active when :input_param:`ABL.perturb_velocity` = true.

.. input_param:: ABL.deltaV

**type:** Real, optional, default = 1.0

Amplitude of fluctuations in y-direction.
Only active when :input_param:`ABL.perturb_velocity` = true.

.. input_param:: ABL.perturb_temperature

**type:** Boolean, optional, default = false

Perturb temperature field with random fluctuations.

.. input_param:: ABL.theta_amplitude
Expand Down Expand Up @@ -124,7 +124,7 @@ This section is for setting atmospheric boundary layer parameters.

Variance for the Gaussian random number generator


.. input_param:: ABL.bndry_file

**type:** String, optional, default = ""
Expand Down Expand Up @@ -154,20 +154,33 @@ This section is for setting atmospheric boundary layer parameters.
**type:** String, optional, default = ""

Variables for IO for ABL inflow

.. input_param:: ABL.wall_shear_stress_type

**type:** String, optional, default = "Moeng"

Wall shear stress model: options include
Wall shear stress model: options include
"constant", "local", "Schumann", and "Moeng"

.. input_param:: ABL.initial_condition_input_file

**type:** String, optional, default= ""

File that contains initial conditions for the
velocity field in netcdf file format.
This file is expected to have the same dimensions as the simulation.
Values are passed directly from the file to the velocity field inside the code.
Only spanwise velocity components are supported.
Only spanwise velocity components are supported.

.. input_param:: ABL.anelastic

**type:** Boolean, optional, default= false

Activate anelastic behavior. This adds `reference_density` and
`reference_pressure` fields.

.. input_param:: ABL.bottom_reference_pressure

**type:** Real, optional, default = 1.01325e5

Reference pressure at the bottom of the domain. Used for anelastic ABL.
1 change: 1 addition & 0 deletions api_docs/_a_b_l_8_h.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@
<code>#include &quot;<a class="el" href="_field_plane_averaging_8_h_source.html">amr-wind/utilities/FieldPlaneAveraging.H</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_a_b_l_stats_base_8_h_source.html">amr-wind/wind_energy/ABLStatsBase.H</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_a_b_l_modulated_power_law_8_h_source.html">amr-wind/wind_energy/ABLModulatedPowerLaw.H</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_a_b_l_anelastic_8_h_source.html">amr-wind/wind_energy/ABLAnelastic.H</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for ABL.H:</div>
<div class="dyncontent">
Expand Down
5 changes: 3 additions & 2 deletions api_docs/_a_b_l_8_h__dep__incl.map
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<map id="ABL.H" name="ABL.H">
<area shape="rect" id="node1" title=" " alt="" coords="983,5,1045,32"/>
<area shape="rect" id="node1" title=" " alt="" coords="1038,5,1099,32"/>
<area shape="rect" id="node2" href="$_a_b_l_forcing_8cpp.html" title=" " alt="" coords="5,87,127,114"/>
<area shape="rect" id="node3" href="$_a_b_l_mean_boussinesq_8cpp.html" title=" " alt="" coords="151,87,335,114"/>
<area shape="rect" id="node4" href="$_a_b_l_meso_forcing_mom_8cpp.html" title=" " alt="" coords="359,87,549,114"/>
Expand All @@ -10,5 +10,6 @@
<area shape="rect" id="node9" href="$incflo__apply__nodal__projection_8cpp.html" title=" " alt="" coords="1189,80,1332,121"/>
<area shape="rect" id="node10" href="$init_8cpp.html" title=" " alt="" coords="1356,87,1427,114"/>
<area shape="rect" id="node11" href="$_a_b_l_8cpp.html" title=" " alt="" coords="1451,87,1526,114"/>
<area shape="rect" id="node12" href="$_a_b_l_wall_function_8cpp.html" title=" " alt="" coords="1551,87,1707,114"/>
<area shape="rect" id="node12" href="$_a_b_l_anelastic_8cpp.html" title=" " alt="" coords="1551,87,1685,114"/>
<area shape="rect" id="node13" href="$_a_b_l_wall_function_8cpp.html" title=" " alt="" coords="1709,87,1865,114"/>
</map>
2 changes: 1 addition & 1 deletion api_docs/_a_b_l_8_h__dep__incl.md5
Original file line number Diff line number Diff line change
@@ -1 +1 @@
484bacba6fcdc62cd9a9e636adf5991d
55cf619f0f993ef4abf4e582c99b0256
73 changes: 44 additions & 29 deletions api_docs/_a_b_l_8_h__dep__incl.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit ba92ca2

Please sign in to comment.