Derived Types

TypeLocationExtendsDescription
absorbLayer_config_typemus_absorbLayer_moduleNone

Contains additional information for absorblayer source

array2D_typemus_scheme_type_moduleNone

To allow Intel AVX SIMD streaming store instructions, the array must be aligned at 32 bytes

array_typemus_bc_header_moduleNone

Simple array type which include array and its size

bc_blackbox_membrane_typemus_bc_header_moduleNone

Contains variables for black-box membrane boundary condition

bc_elems_typemus_bc_header_moduleNone

Level wise boundary elements information

bc_field_elems_typemus_bc_header_moduleNone

Contains field specific element information for each level

bc_inlet_bouzidi_typemus_bc_header_moduleNone

Provides bouzidi coefficients and q-values needed for link-wise implementation of certain inlet boundary conditions.

bc_moments_typemus_bc_header_moduleNone

information needed for moments based boundary condition

bc_neigh_typemus_bc_header_moduleNone

Level wise information about neighbor of boundary elements for a single field

bc_nonEqExpol_typemus_bc_header_moduleNone

Provides coefficients needed for link-wise implementation of nonEquilibrium extrapolation scheme for boundary conditions.

bc_nrbc_typemus_bc_header_moduleNone

variable definition for non-reflective type of boundary conditions\n These boundary condition is taken from the paper:

Read more…
bc_outlet_typemus_bc_header_moduleNone

Provides needed positions for link-wise implementation of outlet boundary condition outlet_expol

bc_states_typemus_bc_header_moduleNone

contains all possible bc state variables needed for boundary

bc_wall_bouzidi_typemus_bc_header_moduleNone

Wall bouzidi data for one level

boundary_typemus_bc_header_moduleNone

Boundary treatment data type. It include boundary treatment for only ONE field. For the same boundary elements, each field may have a different treatment. It includes function pointers and neighbor elements required by this boundary treatment

glob_boundary_typemus_bc_header_moduleNone

Information about boundary elements

Read more…
halo_commBitmask_typemus_construction_moduleNone

Contains bitmask to reduce halo elements communciation links. This type is used only in init_levelBuffers

les_coeff_typemus_turbulence_moduleNone

Contains large Eddy Turbulence (LES) model coefficients

logical_array_typemus_construction_moduleNone
mixRelaxation_typemus_mixture_moduleNone

relaxation paraemters multispecies required for each level

mrt_species_typemus_species_moduleNone

MRT species type

mus_abortCriteria_typemus_abortCriteria_moduletem_solverAborts_type

Musubi specific abort criteria.

mus_absorbLayer_dynAvg_typemus_absorbLayer_moduleNone

Stores time average values of density and velocity for dynamic absorbLayer

mus_absorbLayer_typemus_absorbLayer_moduleNone

Contains information for absorblayer

mus_auxFieldVar_typemus_auxField_moduleNone

Contains auxiliary field variable values per level and communication buffers

mus_bc_corner_typemus_bc_header_moduleNone

contains information needed to treat corner nodes or nodes intersected by more than one boundary type

mus_control_typemus_control_moduleNone

Datatype containing mapping of control routines to function pointers

mus_convertFac_typemus_physics_moduleNone

This type contains the converstion factor for derived variables from lattice to physical.\n Their inverses can be used to convert physical to lattice units use reference density to parmeterize kg and reference mole density to parmeterize mol

mus_derVarPos_typemus_derVarPos_moduleNone

This type stores the position of each variable in the global sys

mus_field_prop_typemus_field_prop_moduleNone

This type contains parameter needed for field

mus_field_typemus_field_moduleNone

This type contains all information on fields with ic and bc Example fields: fluid, species etc. Each field contains one initial condition and array of boundary conditions

mus_fluid_typemus_fluid_moduleNone

collection of properties of the fluid

mus_geom_typemus_geom_moduleNone

Geometric information and definitions

mus_geomIncrHead_typemus_geomIncrHead_moduleNone
mus_Grad_typemus_gradData_moduleNone

collection of properties of the Gradient type

mus_gradData_typemus_gradData_moduleNone

Contains information required to compute gradient like position of six direct neigbors in the state array and coeff for the gradient operation

mus_HRRCorrectionTerm_typemus_source_type_moduleNone

Stores correction term for HRR_bgk

mus_hvs_config_typemus_hvs_config_moduleNone

This datatype describes the various settings to load from the configuration file.

mus_IBM_globTypemus_IBM_moduleNone

This datatype is a wrapper for the immersed boundary information and a possible logging type for debugging

mus_IBM_tmpData_typemus_IBM_moduleNone

This datatype includes all necessary variables needed for 1 IBM step. It will be filled at every timestep.

mus_IBM_typemus_IBM_moduleNone

Datatype containing information on the immersed boundary method

mus_interpolation_config_typemus_interpolate_header_moduleNone

Contains information loaded from config file

mus_interpolation_method_typemus_interpolate_header_moduleNone

This data types contains intpRoutine function pointer for FillFiner and FillCoarser. For fillFiner, it build least square fit matrix for linear quadratic interpolations For fillCoarser: currently we do simple average

Read more…
mus_interpolation_stencil_typemus_interpolate_header_moduleNone

Contains stencil for interpolation

mus_interpolation_typemus_interpolate_header_moduleNone

definition of the used interpolation method

mus_latticeUnit_typemus_param_moduleNone

lattice dx and dt on each level

mus_mixture_typemus_mixture_moduleNone

This type contains mixture information

Read more…
mus_moment_typemus_moments_type_moduleNone

moment space definition

mus_nernstPlanck_typemus_nernstPlanck_moduleNone

Contains configuration to calculate nernst_planck equation. More information can be found in A Coupled Lattice Boltzmann Method to Solve Nernst_Planck Model for simulating Electro-Osmatic Flows by Yang x., Shi B., Chai Z., Guo Z.

mus_nNwtn_CS_typemus_nonNewtonian_moduleNone

The nonNewtonian power law model parameter

Read more…
mus_nNwtn_CY_typemus_nonNewtonian_moduleNone

The nonNewtonian power law model parameter

Read more…
mus_nNwtn_PL_typemus_nonNewtonian_moduleNone

The nonNewtonian power law model parameter

Read more…
mus_nNwtn_typemus_nonNewtonian_moduleNone

The nonNewtonian fluid feature description type

Read more…
mus_param_typemus_param_moduleNone

Global parameter type definition, filled with

mus_physics_typemus_physics_moduleNone

This type contains the basic SI units used to convert lattice to physical unit and vice versa. keep reference mass density, mole density and molecular weight same for all levels.

mus_poisson_boltzmann_typemus_poisson_moduleNone

Contains information to calculate rhs for poisson boltzmann equation. Definition of linear and non-linear poisson boltzmann equation can be found in Masilamani, K. (2010). WaLBerla : Investigation of Electrostatic Effects in Particulate and Electro-Osmotic Flows. Master Thesis. FRIEDRICH-ALEXANDER-UNIVERSITÄT ERLANGEN-NÜRNBERG.

mus_poisson_typemus_poisson_moduleNone

Contains information to solve the poission equation

mus_relaxationParam_typemus_relaxationParam_moduleNone

Contains relaxation parameter for a level

mus_scheme_header_typemus_scheme_header_moduleNone

Datatype containing information to identify the scheme

Read more…
mus_scheme_layout_typemus_scheme_layout_moduleNone

data structure containing all information related to the compute stencil. Several stencils can be defined. mus_moments_module Moments are directly related to the stencil layout and are therefore defined here

mus_scheme_typemus_scheme_type_moduleNone

Datatype containing all information on the scheme.

Read more…
mus_source_elems_typemus_source_type_moduleNone

Contains source elements position in state array and idx to access data variable refered in config file. This type is defined for each level

mus_source_op_typemus_source_type_moduleNone

Description contains list of elements on which source is active and function pointer to update source

mus_source_typemus_source_type_moduleNone

Description of musubi source type

mus_species_typemus_species_moduleNone

this type contains species parameters

Read more…
mus_statistics_typemus_statistics_moduleNone

runtime statistics this includes memory consumption, amount of data to communciate, runtimes etc.

mus_timer_handle_typemus_timer_moduleNone

Musubi timer type --------------------------------------------------

mus_transport_op_typemus_transport_var_moduleNone

Description contains index to access value using variable function pointer

mus_transport_var_typemus_transport_var_moduleNone

Description of musubi transport variable type

mus_turb_wallFunc_data_typemus_turb_wallFunc_moduleNone

Contains friction velocity and turbulent viscosity on boundary elements on each level

mus_turb_wallFunc_typemus_turb_wallFunc_moduleNone

Contains function pointers to compute fuction velocity and stream-wise velocity component

mus_turbChannelForce_typemus_source_type_moduleNone

Contains information to compute average bulk velocity for dynamic_force. In turb_channel_force, the force term is adapted according to difference between reference bulk velocity and simulated plane average bulk velocity to avoid linear increase in simulated bulk velocits. For more information: https://www.wias-berlin.de/people/john/ELECTRONIC_PAPERS/JR07.IJNMF.pdf

mus_turbulence_config_typemus_turbulence_moduleNone

Contains turbulence information loaded from config file

mus_turbulence_data_typemus_turbulence_moduleNone

Contains velocity and gradient data to compute eddy viscosity

mus_turbulence_typemus_turbulence_moduleNone

Contains information required to compute eddy viscosity

mus_turbulence_visc_proc_typemus_turbulence_moduleNone

Contains function pointers to obtain normalized turbulence viscosity. Viscosity is normalized to current level i.e. v_s = v/dt

mus_varSys_data_typemus_varSys_moduleNone

Method data container for every variable

mus_varSys_solverData_typemus_varSys_moduleNone

Contains pointer to musubi data types required for variable operation method_data

mus_viscosity_typemus_relaxationParam_moduleNone

Contains STfun of viscosity variable and relaxation parameter for each level

pdf_data_typemus_pdf_moduleNone

This level-wise data type contains the PDF arrays which are fed into the kernel. The solver updates the state vector and finds the position of the neighbor vectors by looking it up in the neigh array