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

Inheritance diagram for force_torque::force_torque_t:

[legend]

Collaboration diagram for force_torque::force_torque_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, zone_id, zone_name, center, scale, coef, long_print)
	Actual constructor.

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

procedure, pass(this)	compute_ (this, t, tstep)
	Compute the force_torque 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	p
	Pressure.

type(vector_t)	n1

type(vector_t)	n2

type(vector_t)	n3

type(vector_t)	r1

type(vector_t)	r2

type(vector_t)	r3

type(vector_t)	force1

type(vector_t)	force2

type(vector_t)	force3

type(vector_t)	force4

type(vector_t)	force5

type(vector_t)	force6

type(vector_t)	pmsk

type(vector_t)	s11msk

type(vector_t)	s22msk

type(vector_t)	s33msk

type(vector_t)	s12msk

type(vector_t)	s13msk

type(vector_t)	s23msk

real(kind=rp), dimension(3)	center = 0.0_rp

real(kind=rp)	scale

integer	zone_id

character(len=20)	zone_name

type(coef_t), pointer	coef

type(dirichlet_t)	bc

character(len=80)	print_format

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 65 of file force_torque.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) force_torque::force_torque_t::compute_	(	class(force_torque_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 99 of file force_torque.f90.

◆ compute_() [2/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.

◆ free() [1/2]

procedure, pass(this) force_torque::force_torque_t::free ( class(force_torque_t), intent(inout) this )

Definition at line 97 of file force_torque.f90.

◆ free() [2/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_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, pass(this) force_torque::force_torque_t::init	(	class(force_torque_t), intent(inout)	this,
		type(json_file), intent(inout)	json,
		class(case_t), intent(inout), target	case
	)

Definition at line 92 of file force_torque.f90.

◆ init() [2/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_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) force_torque::force_torque_t::init_from_attributes	(	class(force_torque_t), intent(inout)	this,
		integer, intent(in)	zone_id,
		character(len=*), intent(in)	zone_name,
		real(kind=rp), dimension(3), intent(in)	center,
		real(kind=rp), intent(in)	scale,
		type(coef_t), intent(in), target	coef,
		logical, intent(in)	long_print
	)

Definition at line 94 of file force_torque.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

◆ bc

type(dirichlet_t) force_torque::force_torque_t::bc

Definition at line 87 of file force_torque.f90.

◆ case

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

inherited

Definition at line 50 of file simulation_component.f90.

◆ center

real(kind=rp), dimension(3) force_torque::force_torque_t::center = 0.0_rp

Definition at line 82 of file force_torque.f90.

◆ coef

type(coef_t), pointer force_torque::force_torque_t::coef

Definition at line 86 of file force_torque.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.

◆ force1

type(vector_t) force_torque::force_torque_t::force1

Definition at line 78 of file force_torque.f90.

◆ force2

type(vector_t) force_torque::force_torque_t::force2

Definition at line 78 of file force_torque.f90.

◆ force3

type(vector_t) force_torque::force_torque_t::force3

Definition at line 78 of file force_torque.f90.

◆ force4

type(vector_t) force_torque::force_torque_t::force4

Definition at line 79 of file force_torque.f90.

◆ force5

type(vector_t) force_torque::force_torque_t::force5

Definition at line 79 of file force_torque.f90.

◆ force6

type(vector_t) force_torque::force_torque_t::force6

Definition at line 79 of file force_torque.f90.

◆ n1

type(vector_t) force_torque::force_torque_t::n1

Definition at line 76 of file force_torque.f90.

◆ n2

type(vector_t) force_torque::force_torque_t::n2

Definition at line 76 of file force_torque.f90.

◆ n3

type(vector_t) force_torque::force_torque_t::n3

Definition at line 76 of file force_torque.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.

◆ p

type(field_t), pointer force_torque::force_torque_t::p

Definition at line 73 of file force_torque.f90.

◆ pmsk

type(vector_t) force_torque::force_torque_t::pmsk

Definition at line 80 of file force_torque.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.

◆ print_format

character(len=80) force_torque::force_torque_t::print_format

Definition at line 88 of file force_torque.f90.

◆ r1

type(vector_t) force_torque::force_torque_t::r1

Definition at line 77 of file force_torque.f90.

◆ r2

type(vector_t) force_torque::force_torque_t::r2

Definition at line 77 of file force_torque.f90.

◆ r3

type(vector_t) force_torque::force_torque_t::r3

Definition at line 77 of file force_torque.f90.

◆ s11msk

type(vector_t) force_torque::force_torque_t::s11msk

Definition at line 81 of file force_torque.f90.

◆ s12msk

type(vector_t) force_torque::force_torque_t::s12msk

Definition at line 81 of file force_torque.f90.

◆ s13msk

type(vector_t) force_torque::force_torque_t::s13msk

Definition at line 81 of file force_torque.f90.

◆ s22msk

type(vector_t) force_torque::force_torque_t::s22msk

Definition at line 81 of file force_torque.f90.

◆ s23msk

type(vector_t) force_torque::force_torque_t::s23msk

Definition at line 81 of file force_torque.f90.

◆ s33msk

type(vector_t) force_torque::force_torque_t::s33msk

Definition at line 81 of file force_torque.f90.

◆ scale

real(kind=rp) force_torque::force_torque_t::scale

Definition at line 83 of file force_torque.f90.

◆ u

type(field_t), pointer force_torque::force_torque_t::u

Definition at line 67 of file force_torque.f90.

◆ v

type(field_t), pointer force_torque::force_torque_t::v

Definition at line 69 of file force_torque.f90.

◆ w

type(field_t), pointer force_torque::force_torque_t::w

Definition at line 71 of file force_torque.f90.

◆ zone_id

integer force_torque::force_torque_t::zone_id

Definition at line 84 of file force_torque.f90.

◆ zone_name

character(len=20) force_torque::force_torque_t::zone_name

Definition at line 85 of file force_torque.f90.

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

/home/runner/work/neko/neko/src/simulation_components/force_torque.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

◆ bc

◆ case

◆ center

◆ coef

◆ compute_controller

◆ force1

◆ force2

◆ force3

◆ force4

◆ force5

◆ force6

◆ n1

◆ n2

◆ n3

◆ order

◆ output_controller

◆ p

◆ pmsk

◆ preprocess_controller

◆ print_format

◆ r1

◆ r2

◆ r3

◆ s11msk

◆ s12msk

◆ s13msk

◆ s22msk

◆ s23msk

◆ s33msk

◆ scale

◆ u

◆ v

◆ w

◆ zone_id

◆ zone_name