A simulation component that computes the vorticity field. Added to the field registry as omega_x, omega_y, andomega_z`. More...

Inheritance diagram for vorticity::vorticity_t:

[legend]

Collaboration diagram for vorticity::vorticity_t:

[legend]

Public Member Functions
procedure, pass(this)	init (this, json, case)
	Constructor from json, wrapping the actual constructor.

procedure, pass(this)	init_from_attributes (this)
	Actual constructor.

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

procedure, pass(this)	compute_ (this, t, tstep)
	Compute the vorticity field.

procedure, pass(this)	init_base (this, json, case)
	Constructor for the simulation_component_t (base) class.

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

procedure, pass(this)	restart (this, t)
	Wrapper for calling `set_counter` for the time based controllers. Serves as the public interface.

procedure, pass(this)	preprocess (this, t, tstep)
	Wrapper for calling `preprocess_` based on the `preprocess_controller`. Serves as the public interface.

procedure, pass(this)	compute (this, t, tstep)
	Wrapper for calling `compute_` based on the `compute_controller`. Serves as the public interface.

procedure(simulation_component_init), deferred, pass	init (this, json, case)
	The common constructor using a JSON dictionary.

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

procedure, pass(this)	preprocess_ (this, t, tstep)
	The preprocessing function to be executed during the run.

procedure, pass(this)	compute_ (this, t, tstep)
	The main function to be executed during the run.

procedure, pass(this)	restart_ (this, t)
	The restart function to be called upon restarting simulation.

Public Attributes
type(field_t), pointer	u
	X velocity component.

type(field_t), pointer	v
	Y velocity component.

type(field_t), pointer	w
	Z velocity component.

type(field_t), pointer	omega_x
	X vorticity component.

type(field_t), pointer	omega_y
	Y vorticity component.

type(field_t), pointer	omega_z
	Z vorticity component.

type(field_t)	temp1
	Work array.

type(field_t)	temp2
	Work array.

type(field_writer_t)	writer
	Output writer.

type(case_t), pointer	case
	Pointer to the simulation case.

type(time_based_controller_t)	preprocess_controller
	Controller for when to run `preprocess`.

type(time_based_controller_t)	compute_controller
	Controller for when to run `compute`.

type(time_based_controller_t)	output_controller
	Controller for when to do output.

integer	order
	The execution order, lowest excutes first.

Detailed Description

Definition at line 52 of file vorticity.f90.

Member Function/Subroutine Documentation

◆ compute()

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

inherited

Parameters

t	The time value.
tstep	The current time-step

Definition at line 73 of file simulation_component.f90.

◆ compute_() [1/2]

procedure, pass(this) simulation_component::simulation_component_t::compute_	(	class(simulation_component_t), intent(inout)	this,
		real(kind=rp), intent(in)	t,
		integer, intent(in)	tstep
	)

inherited

Parameters

t	The time value.
tstep	The current time-step

Definition at line 81 of file simulation_component.f90.

◆ compute_() [2/2]

procedure, pass(this) vorticity::vorticity_t::compute_	(	class(vorticity_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 84 of file vorticity.f90.

◆ free() [1/2]

procedure(simulation_component_free), deferred, pass simulation_component::simulation_component_t::free ( class(simulation_component_t), intent(inout) this )

pure virtualinherited

Definition at line 77 of file simulation_component.f90.

◆ free() [2/2]

procedure, pass(this) vorticity::vorticity_t::free ( class(vorticity_t), intent(inout) this )

Definition at line 82 of file vorticity.f90.

◆ free_base()

procedure, pass(this) simulation_component::simulation_component_t::free_base ( class(simulation_component_t), intent(inout) this )

inherited

Definition at line 63 of file simulation_component.f90.

◆ init() [1/2]

procedure(simulation_component_init), deferred, pass simulation_component::simulation_component_t::init	(	class(simulation_component_t), intent(inout)	this,
		type(json_file), intent(inout)	json,
		class(case_t), intent(inout), target	case
	)

pure virtualinherited

Definition at line 75 of file simulation_component.f90.

◆ init() [2/2]

procedure, pass(this) vorticity::vorticity_t::init	(	class(vorticity_t), intent(inout)	this,
		type(json_file), intent(inout)	json,
		class(case_t), intent(inout), target	case
	)

Definition at line 77 of file vorticity.f90.

◆ init_base()

procedure, pass(this) simulation_component::simulation_component_t::init_base	(	class(simulation_component_t), intent(inout)	this,
		type(json_file), intent(inout)	json,
		class(case_t), intent(inout), target	case
	)

inherited

Parameters

object	The object to be created and initialized.
json	JSON object initializing the simulation component.
case	The simulation case. Constructor for the `simulation_component_t` (base) class.

Definition at line 61 of file simulation_component.f90.

◆ init_from_attributes()

procedure, pass(this) vorticity::vorticity_t::init_from_attributes ( class(vorticity_t), intent(inout) this )

Definition at line 79 of file vorticity.f90.

◆ preprocess()

procedure, pass(this) simulation_component::simulation_component_t::preprocess	(	class(simulation_component_t), intent(inout)	this,
		real(kind=rp), intent(in)	t,
		integer, intent(in)	tstep
	)

inherited

Parameters

t	The time value.
tstep	The current time-step

Definition at line 69 of file simulation_component.f90.

◆ preprocess_()

procedure, pass(this) simulation_component::simulation_component_t::preprocess_	(	class(simulation_component_t), intent(inout)	this,
		real(kind=rp), intent(in)	t,
		integer, intent(in)	tstep
	)

inherited

Parameters

t	The time value.
tstep	The current time-step

Definition at line 79 of file simulation_component.f90.

◆ restart()

procedure, pass(this) simulation_component::simulation_component_t::restart	(	class(simulation_component_t), intent(inout)	this,
		real(kind=rp), intent(in)	t
	)

inherited

Parameters

t	The time value.

Definition at line 66 of file simulation_component.f90.

◆ restart_()

procedure, pass(this) simulation_component::simulation_component_t::restart_	(	class(simulation_component_t), intent(inout)	this,
		real(kind=rp), intent(in)	t
	)

inherited

Parameters

t	The time value.

Definition at line 83 of file simulation_component.f90.

Member Data Documentation

◆ case

type(case_t), pointer simulation_component::simulation_component_t::case

inherited

Definition at line 50 of file simulation_component.f90.

◆ compute_controller

type(time_based_controller_t) simulation_component::simulation_component_t::compute_controller

inherited

Definition at line 54 of file simulation_component.f90.

◆ omega_x

type(field_t), pointer vorticity::vorticity_t::omega_x

Definition at line 61 of file vorticity.f90.

◆ omega_y

type(field_t), pointer vorticity::vorticity_t::omega_y

Definition at line 63 of file vorticity.f90.

◆ omega_z

type(field_t), pointer vorticity::vorticity_t::omega_z

Definition at line 65 of file vorticity.f90.

◆ order

integer simulation_component::simulation_component_t::order

inherited

Definition at line 58 of file simulation_component.f90.

◆ output_controller

type(time_based_controller_t) simulation_component::simulation_component_t::output_controller

inherited

Definition at line 56 of file simulation_component.f90.

◆ preprocess_controller

type(time_based_controller_t) simulation_component::simulation_component_t::preprocess_controller

inherited

Definition at line 52 of file simulation_component.f90.

◆ temp1

type(field_t) vorticity::vorticity_t::temp1

Definition at line 68 of file vorticity.f90.

◆ temp2

type(field_t) vorticity::vorticity_t::temp2

Definition at line 70 of file vorticity.f90.

◆ u

type(field_t), pointer vorticity::vorticity_t::u

Definition at line 54 of file vorticity.f90.

◆ v

type(field_t), pointer vorticity::vorticity_t::v

Definition at line 56 of file vorticity.f90.

◆ w

type(field_t), pointer vorticity::vorticity_t::w

Definition at line 58 of file vorticity.f90.

◆ writer

type(field_writer_t) vorticity::vorticity_t::writer

Definition at line 73 of file vorticity.f90.

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

/home/runner/work/neko/neko/src/simulation_components/vorticity.f90

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ compute()

◆ compute_() [1/2]

◆ compute_() [2/2]

◆ free() [1/2]

◆ free() [2/2]

◆ free_base()

◆ init() [1/2]

◆ init() [2/2]

◆ init_base()

◆ init_from_attributes()

◆ preprocess()

◆ preprocess_()

◆ restart()

◆ restart_()

Member Data Documentation

◆ case

◆ compute_controller

◆ omega_x

◆ omega_y

◆ omega_z

◆ order

◆ output_controller

◆ preprocess_controller

◆ temp1

◆ temp2

◆ u

◆ v

◆ w

◆ writer