artificial_viscosity::artificial_viscosity_t Type Reference

The handler for the artificial viscosity. More...

Inheritance diagram for artificial_viscosity::artificial_viscosity_t:

Collaboration diagram for artificial_viscosity::artificial_viscosity_t:

Public Member Functions
procedure, pass(this)	init (this, json, coef, dof)
	Initialize the artificial viscosity regularization.
procedure, pass(this)	free (this)
	Free the artificial viscosity regularization.
procedure, pass(this)	update (this, effective_visc, mu)
	Update the effective viscosity field.
procedure, pass(this)	init_base (this, json, coef, dof)
	Initialize state shared by all regularization methods.
procedure, pass(this)	free_base (this)
	Free state shared by all regularization methods.
procedure(reg_init), deferred, pass	init (this, json, coef, dof)
	Initialize a regularization method.
procedure(reg_free), deferred, pass	free (this)
	Free a regularization method.
procedure(reg_update), deferred, pass	update (this, effective_visc, mu)
	Update the effective viscosity field.

Public Attributes
type(field_t), pointer	reg_coeff => null()
	Spatially varying regularization coefficient.
character(len=:), allocatable	reg_coeff_name
	Name of the regularization coefficient field.
type(coef_t), pointer	coef => null()
	SEM coefficients.
type(dofmap_t), pointer	dof => null()
	SEM map of degrees of freedom.

Detailed Description

Definition at line 50 of file artificial_viscosity.f90.

Member Function/Subroutine Documentation

free() [1/2]

procedure, pass(this) artificial_viscosity::artificial_viscosity_t::free

(

class(artificial_viscosity_t), intent(inout)

this

)

Parameters

this	The artificial viscosity regularization.

Definition at line 55 of file artificial_viscosity.f90.

free() [2/2]

procedure(reg_free), deferred, pass viscous_regularization::viscous_regularization_t::free ( class(viscous_regularization_t), intent(inout)  this )

pure virtualinherited

Definition at line 62 of file viscous_regularization.f90.

free_base()

procedure, pass(this) viscous_regularization::viscous_regularization_t::free_base ( class(viscous_regularization_t), intent(inout)  this )

inherited

Parameters

this	The viscous regularization method.

Definition at line 58 of file viscous_regularization.f90.

init() [1/2]

procedure, pass(this) artificial_viscosity::artificial_viscosity_t::init	(	class(artificial_viscosity_t), intent(inout)	this,
		type(json_file), intent(inout)	json,
		type(coef_t), intent(in), target	coef,
		type(dofmap_t), intent(in), target	dof
	)

Parameters

this	The artificial viscosity regularization.
json	The regularization configuration.
coef	The SEM coefficients.
dof	The SEM map of degrees of freedom.

Definition at line 53 of file artificial_viscosity.f90.

init() [2/2]

procedure(reg_init), deferred, pass viscous_regularization::viscous_regularization_t::init ( class(viscous_regularization_t), intent(inout)  this, type(json_file), intent(inout)  json, type(coef_t), intent(in), target  coef, type(dofmap_t), intent(in), target  dof  )

pure virtualinherited

Definition at line 60 of file viscous_regularization.f90.

init_base()

procedure, pass(this) viscous_regularization::viscous_regularization_t::init_base ( class(viscous_regularization_t), intent(inout)  this, type(json_file), intent(inout)  json, type(coef_t), intent(in), target  coef, type(dofmap_t), intent(in), target  dof  )

inherited

Parameters

object	The regularization object to allocate.
type_name	The regularization type name.
json	The regularization configuration.
coef	The SEM coefficients.
dof	The SEM map of degrees of freedom. Initialize state shared by all viscous regularization methods.
this	The viscous regularization method.
json	The regularization configuration.
coef	The SEM coefficients.
dof	The SEM map of degrees of freedom.

Definition at line 56 of file viscous_regularization.f90.

update() [1/2]

procedure, pass(this) artificial_viscosity::artificial_viscosity_t::update	(	class(artificial_viscosity_t), intent(inout)	this,
		type(field_t), intent(inout)	effective_visc,
		type(field_t), intent(in), optional	mu
	)

Parameters

this	The artificial viscosity regularization.
effective_visc	The effective viscosity field to update.
mu	The optional physical viscosity field.

Definition at line 57 of file artificial_viscosity.f90.

update() [2/2]

procedure(reg_update), deferred, pass viscous_regularization::viscous_regularization_t::update ( class(viscous_regularization_t), intent(inout)  this, type(field_t), intent(inout)  effective_visc, type(field_t), intent(in), optional  mu  )

pure virtualinherited

Definition at line 64 of file viscous_regularization.f90.

Member Data Documentation

coef

type(coef_t), pointer viscous_regularization::viscous_regularization_t::coef => null()

inherited

Definition at line 51 of file viscous_regularization.f90.

dof

type(dofmap_t), pointer viscous_regularization::viscous_regularization_t::dof => null()

inherited

Definition at line 53 of file viscous_regularization.f90.

reg_coeff

type(field_t), pointer viscous_regularization::viscous_regularization_t::reg_coeff => null()

inherited

Definition at line 47 of file viscous_regularization.f90.

reg_coeff_name

character(len=:), allocatable viscous_regularization::viscous_regularization_t::reg_coeff_name

inherited

Definition at line 49 of file viscous_regularization.f90.

---

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

• /home/runner/work/neko/neko/src/viscous_regularization/artificial_viscosity.f90