Implements the Sigma LES model. More...

Inheritance diagram for sigma::sigma_t:

Collaboration diagram for sigma::sigma_t:

[legend]

Public Member Functions
procedure, pass(this)	init (this, fluid, json)
	Constructor from JSON.

procedure, pass(this)	init_from_components (this, fluid, c, nut_name, delta_type, if_ext)
	Constructor from components.

procedure, pass(this)	free (this)
	Destructor.

procedure, pass(this)	compute (this, t, tstep)
	Compute eddy viscosity.

procedure, pass(this)	init_base (this, fluid, nut_name, delta_type, if_ext)
	Constructor for the les_model_t (base) class.

procedure, pass(this)	free_base (this)
	Destructor for the les_model_t (base) class.

procedure, pass(this)	compute_delta (this)
	Compute the LES length-scale.

procedure(les_model_init), deferred, pass	init (this, fluid, json)
	The common constructor.

procedure(les_model_free), deferred, pass	free (this)
	Destructor.

procedure(les_model_compute), deferred, pass	compute (this, t, tstep)
	Compute eddy viscosity.

Public Attributes
real(kind=rp)	c
	Model constant, default to 1.35.

type(time_scheme_controller_t), pointer	ext_bdf => null()
	Pointer to the extrapolation scheme.

type(field_series_t), pointer	ulag => null()
	Pointer to the lag list of the velocities.

type(field_series_t), pointer	vlag => null()

type(field_series_t), pointer	wlag => null()

class(rhs_maker_sumab_t), allocatable	sumab
	Summation of AB/BDF contributions to extrapolate the field.

logical	if_ext = .false.
	Logical variable for extrapolation.

type(field_t), pointer	nut => null()
	Subgrid kinematic viscosity.

character(len=:), allocatable	delta_type
	LES lengthscale type.

type(field_t), pointer	delta => null()
	LES lengthscale.

type(coef_t), pointer	coef => null()
	SEM coefficients.

Detailed Description

Note: Reference DOI: 10.1063/1.3623274

Definition at line 52 of file sigma.f90.

Member Function/Subroutine Documentation

◆ compute() [1/2]

procedure(les_model_compute), deferred, pass les_model::les_model_t::compute	(	class(les_model_t), intent(inout)	this,
		real(kind=rp), intent(in)	t,
		integer, intent(in)	tstep
	)

pure virtualinherited

Definition at line 96 of file les_model.f90.

◆ compute() [2/2]

procedure, pass(this) sigma::sigma_t::compute	(	class(sigma_t), intent(inout)	this,
		real(kind=rp), intent(in)	t,
		integer, intent(in)	tstep
	)

Parameters

t	The time value.
tstep	The current time-step.

Definition at line 64 of file sigma.f90.

◆ compute_delta()

procedure, pass(this) les_model::les_model_t::compute_delta ( class(les_model_t), intent(inout) this )

inherited

Definition at line 90 of file les_model.f90.

◆ free() [1/2]

procedure(les_model_free), deferred, pass les_model::les_model_t::free ( class(les_model_t), intent(inout) this )

pure virtualinherited

Definition at line 94 of file les_model.f90.

◆ free() [2/2]

procedure, pass(this) sigma::sigma_t::free ( class(sigma_t), intent(inout) this )

Definition at line 62 of file sigma.f90.

◆ free_base()

procedure, pass(this) les_model::les_model_t::free_base ( class(les_model_t), intent(inout) this )

inherited

Definition at line 88 of file les_model.f90.

◆ init() [1/2]

procedure(les_model_init), deferred, pass les_model::les_model_t::init	(	class(les_model_t), intent(inout)	this,
		class(fluid_scheme_base_t), intent(inout), target	fluid,
		type(json_file), intent(inout)	json
	)

pure virtualinherited

Definition at line 92 of file les_model.f90.

◆ init() [2/2]

procedure, pass(this) sigma::sigma_t::init	(	class(sigma_t), intent(inout)	this,
		class(fluid_scheme_base_t), intent(inout), target	fluid,
		type(json_file), intent(inout)	json
	)

Parameters

fluid	The fluid_scheme_base_t object.
json	A dictionary with parameters.

Definition at line 57 of file sigma.f90.

◆ init_base()

procedure, pass(this) les_model::les_model_t::init_base	(	class(les_model_t), intent(inout)	this,
		class(fluid_scheme_base_t), intent(inout), target	fluid,
		character(len=*), intent(in)	nut_name,
		character(len=*), intent(in)	delta_type,
		logical, intent(in)	if_ext
	)

inherited

Parameters

object	The object to be allocated.
type_name	The name of the LES model.
dofmap	SEM map of degrees of freedom.
coef	SEM coefficients.
json	A dictionary with parameters. Constructor for the les_model_t (base) class.
fluid	The fluid_scheme_t object.
nu_name	The name of the turbulent viscosity field.
delta_type	The type of filter size.
if_ext	Whether trapolate the velocity.

Definition at line 86 of file les_model.f90.

◆ init_from_components()

procedure, pass(this) sigma::sigma_t::init_from_components	(	class(sigma_t), intent(inout)	this,
		class(fluid_scheme_base_t), intent(inout), target	fluid,
		real(kind=rp)	c,
		character(len=*), intent(in)	nut_name,
		character(len=*), intent(in)	delta_type,
		logical, intent(in)	if_ext
	)

Parameters

fluid	The fluid_scheme_base_t object.
c	The model constant.
nut_name	The name of the SGS viscosity field.
delta_type	The type of filter size.
if_ext	Whether trapolate the velocity.

Definition at line 59 of file sigma.f90.

Member Data Documentation

◆ c

real(kind=rp) sigma::sigma_t::c

Definition at line 54 of file sigma.f90.

◆ coef

type(coef_t), pointer les_model::les_model_t::coef => null()

inherited

Definition at line 83 of file les_model.f90.

◆ delta

type(field_t), pointer les_model::les_model_t::delta => null()

inherited

Definition at line 81 of file les_model.f90.

◆ delta_type

character(len=:), allocatable les_model::les_model_t::delta_type

inherited

Definition at line 79 of file les_model.f90.

◆ ext_bdf

type(time_scheme_controller_t), pointer les_model::les_model_t::ext_bdf => null()

inherited

Definition at line 67 of file les_model.f90.

◆ if_ext

logical les_model::les_model_t::if_ext = .false.

inherited

Definition at line 75 of file les_model.f90.

◆ nut

type(field_t), pointer les_model::les_model_t::nut => null()

inherited

Definition at line 77 of file les_model.f90.

◆ sumab

class(rhs_maker_sumab_t), allocatable les_model::les_model_t::sumab

inherited

Definition at line 73 of file les_model.f90.

◆ ulag

type(field_series_t), pointer les_model::les_model_t::ulag => null()

inherited

Definition at line 69 of file les_model.f90.

◆ vlag

type(field_series_t), pointer les_model::les_model_t::vlag => null()

inherited

Definition at line 70 of file les_model.f90.

◆ wlag

type(field_series_t), pointer les_model::les_model_t::wlag => null()

inherited

Definition at line 71 of file les_model.f90.

The documentation for this type was generated from the following file:

/home/runner/work/neko/neko/src/les/sigma.f90

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ compute() [1/2]

◆ compute() [2/2]

◆ compute_delta()

◆ free() [1/2]

◆ free() [2/2]

◆ free_base()

◆ init() [1/2]

◆ init() [2/2]

◆ init_base()

◆ init_from_components()

Member Data Documentation

◆ c

◆ coef

◆ delta

◆ delta_type

◆ ext_bdf

◆ if_ext

◆ nut

◆ sumab

◆ ulag

◆ vlag

◆ wlag