Neko  0.9.0
A portable framework for high-order spectral element flow simulations
vorticity::vorticity_t Type Reference

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:
Collaboration diagram for vorticity::vorticity_t:

Public Member Functions

procedure, pass(this) init => vorticity_init_from_json
 Constructor from json, wrapping the actual constructor. More...
 
procedure, pass(this) init_from_attributes => vorticity_init_from_attributes
 Actual constructor. More...
 
procedure, pass(this) free => vorticity_free
 Destructor. More...
 
procedure, pass(this) compute_ => vorticity_compute
 Compute the vorticity field. More...
 
procedure, pass(this) init_base => simulation_component_init_base
 Constructor for the simulation_component_t (base) class. More...
 
procedure, pass(this) free_base => simulation_component_free_base
 Destructor for the simulation_component_t (base) class. More...
 
procedure, pass(this) restart => simulation_component_restart_wrapper
 Wrapper for calling set_counter for the time based controllers. Serves as the public interface. More...
 
procedure, pass(this) preprocess => simulation_component_preprocess_wrapper
 Wrapper for calling preprocess_ based on the preprocess_controller. Serves as the public interface. More...
 
procedure, pass(this) compute => simulation_component_compute_wrapper
 Wrapper for calling compute_ based on the compute_controller. Serves as the public interface. More...
 
procedure, pass(this) preprocess_
 The preprocessing function to be executed during the run. More...
 
procedure, pass(this) restart_
 The restart function to be called upon restarting simulation. More...
 

Public Attributes

type(field_t), pointer u
 X velocity component. More...
 
type(field_t), pointer v
 Y velocity component. More...
 
type(field_t), pointer w
 Z velocity component. More...
 
type(field_t), pointer omega_x
 X vorticity component. More...
 
type(field_t), pointer omega_y
 Y vorticity component. More...
 
type(field_t), pointer omega_z
 Z vorticity component. More...
 
type(field_ttemp1
 Work array. More...
 
type(field_ttemp2
 Work array. More...
 
type(field_writer_twriter
 Output writer. More...
 
type(case_t), pointer case
 Pointer to the simulation case. More...
 
type(time_based_controller_t) preprocess_controller
 Controller for when to run preprocess. More...
 
type(time_based_controller_t) compute_controller
 Controller for when to run compute. More...
 
type(time_based_controller_t) output_controller
 Controller for when to do output. More...
 
integer order
 The execution order, lowest excutes first. More...
 

Detailed Description

Definition at line 52 of file vorticity.f90.

Member Function/Subroutine Documentation

◆ compute()

procedure, pass(this) simulation_component::simulation_component_t::compute
inherited

Definition at line 73 of file simulation_component.f90.

◆ compute_()

procedure, pass(this) vorticity::vorticity_t::compute_

Definition at line 84 of file vorticity.f90.

◆ free()

procedure, pass(this) vorticity::vorticity_t::free

Definition at line 82 of file vorticity.f90.

◆ free_base()

procedure, pass(this) simulation_component::simulation_component_t::free_base
inherited

Definition at line 63 of file simulation_component.f90.

◆ init()

procedure, pass(this) vorticity::vorticity_t::init

Definition at line 77 of file vorticity.f90.

◆ init_base()

procedure, pass(this) simulation_component::simulation_component_t::init_base
inherited

Definition at line 61 of file simulation_component.f90.

◆ init_from_attributes()

procedure, pass(this) vorticity::vorticity_t::init_from_attributes

Definition at line 79 of file vorticity.f90.

◆ preprocess()

procedure, pass(this) simulation_component::simulation_component_t::preprocess
inherited

Definition at line 69 of file simulation_component.f90.

◆ preprocess_()

procedure, pass(this) simulation_component::simulation_component_t::preprocess_
inherited

Definition at line 79 of file simulation_component.f90.

◆ restart()

procedure, pass(this) simulation_component::simulation_component_t::restart
inherited

Definition at line 66 of file simulation_component.f90.

◆ restart_()

procedure, pass(this) simulation_component::simulation_component_t::restart_
inherited

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: