Modules

ModuleSource FileDescription
mus_abortCriteria_modulemus_abortCriteria_module.f90

Musubi specific criteria to abort the simulation.

Read more…
mus_absorbLayer_modulemus_absorbLayer_module.f90

Module containing subroutines for building MUSUBI specific absorbLayer source variables

Read more…
mus_aux_modulemus_aux_module.f90
mus_auxField_modulemus_auxField_module.f90

This module contains routine to retrieve auxiliary field variables for getElement, getPoint, setupIndices and getValOfIndex. Auxilary field variables are: * density and velocity for fluid * species desity and velocity for multispecies * potential for poisson

mus_bc_nernstPlanck_modulemus_bc_nernstPlanck_module.f90

Boundary condition treatment routines for Nernst-Planck equation

Read more…
mus_bc_poisson_modulemus_bc_poisson_module.f90

Boundary condition treatment routines for Poisson equation

Read more…
mus_bc_var_modulemus_bc_var_module.f90

This module provides variable to extract from boundary condition

mus_comm_modulemus_comm_module.f90

This module provides the definition and methods for musubi-specific communication. It includes the wrapper functions for the actual communication, which is defined in tem_comm_module.

mus_config_modulemus_config_module.f90

In this module, all parameter files are read in as lua script or a sample configuration is being loaded

Read more…
mus_control_modulemus_control_module.f90

In this module, the control structure for computing each time step is established.

Read more…
mus_cumulantInit_modulemus_cumulantInit_module.f90

This module contains functions for initializing Cumulant relaxation paramaters author: Gregorio Gerardo Spinelli

mus_derVarPos_modulemus_derVarPos_module.f90

This module contains the type defintion which stores position of all derive variables in global varSys.

Read more…
mus_directions_modulemus_directions_module.f90

This module contains parameters to address the stencil directions. These parameters are valid for all stencils, however, the direction q00 and q000 needs to be set on each use according to QQ.

mus_dynLoadBal_modulemus_dynLoadBal_module.f90
mus_eNRTL_modulemus_eNRTL_dummy.f90

This module contains an interface for external C++ code to compute liquid mixture property like thermodynamic factor and Maxwell-Stefan Diffusivity coefficients

mus_eNRTL_modulemus_eNRTL_module.f90

This module contains an interface for external C++ code to compute liquid mixture property like thermodynamic factor and Maxwell-Stefan Diffusivity coefficients

mus_field_modulemus_field_module.f90

This module contains information about all fields like fluid, species, temperature etc. This field type will be used for multispecies and passive scalar transport.

Read more…
mus_field_prop_modulemus_field_prop_module.f90

This module contains mus_field_prop_type and modules related to fiels properties.

Read more…
mus_fluid_modulemus_fluid_module.f90

This module keeps all information about the fluid

Read more…
mus_geom_modulemus_geom_module.f90

This module contains the definition of geometry type and routines to geometry information like mesh, boundary, immersed_boundary and restart

mus_geomIncrHead_modulemus_geomIncrHead_module.f90

This module contains the datatypes for the geometry increase table within the lua configuration file. It also contains the routines to load various variables, parameters from the lua file which are then used in performing geometry changes

mus_hrrInit_modulemus_hrrInit_module.f90

This module provides the definitions of M and Minv for MRT advection relaxation scheme for all stencils.

Read more…
mus_hvs_aux_modulemus_hvs_aux_module.f90

Auxiliary functionality for musubi harvesting

mus_hvs_config_modulemus_hvs_config_module.f90

In this module, all parameter files are read in as lua script or a sample configuration is being loaded

Read more…
mus_hvs_construction_modulemus_hvs_construction_module.f90

mus_hvs_construct "Creation of the data structures" from the information in the configuration and from the mesh read from disk for the musubi harvesting

mus_initFluid_modulemus_initFluid_module.f90

This module contains routines which initiliaze advection relaxation and flow field for lbm model.

mus_initFluidIncomp_modulemus_initFluidIncomp_module.f90

This module contains routines which initiliaze advection relaxation and flow field for lbm incompressible model.

mus_initIsothermAcEq_modulemus_initIsothermAcEq_module.f90

This module contains routines which initiliaze advection relaxation and flow field for lbm model for acoustic equations.

mus_initLBMPS_modulemus_initLBMPS_module.f90

This module contains routines which assigns compute kernel for passive scalar model

mus_initMultispecies_modulemus_initMultispecies_module.f90

This module contains routines which initiliaze advection relaxation and flow field for multispecies lbm gas model and liquid model.

mus_initNernstPlanck_modulemus_initNernstPlanck_module.f90

This module contains routines which initiliaze advection relaxation and flow field for lbm incompressible model.

mus_initPoisson_modulemus_initPoisson_module.f90

This module contains routines which initiliaze advection relaxation and flow field for lbm incompressible model.

mus_interpolate_header_modulemus_interpolate_header_module.f90

Interpolation header to load confiugration and type definition

mus_mesh_adaptation_modulemus_mesh_adaptation_module.f90

This module contains the code responsible for adaptively refining the mesh during run time.

mus_mixture_modulemus_mixture_module.f90

This module contains all information about fluid mixture

mus_moments_modulemus_moments_module.f90

This module deals with the calculation of moments from pdfs

mus_moments_type_modulemus_moments_type_module.f90

This module provides a data type for moment definition

mus_mrtInit_modulemus_mrtInit_module.f90

This module provides the definitions of M and Minv for MRT advection relaxation scheme for all stencils.

Read more…
mus_nernstPlanck_modulemus_nernstPlanck_module.f90
mus_param_modulemus_param_module.f90

This module provides the definition and methods for boundarys.

mus_pdf_modulemus_pdf_module.f90

Definitions for the main state and neighbor arrays

mus_physics_modulemus_physics_module.f90

This module contains data type and modules related to musubi lattice to physical unit convertion and vice versa. \n physics data type is global for all scheme, it is defined in the following format: \n

Read more…
mus_poisson_modulemus_poisson_module.f90
mus_relaxationParam_modulemus_relaxationParam_module.f90

This module contains the data type for MRT.

Read more…
mus_restart_modulemus_restart_module.f90

This module provides the MUSUBI subroutines needed for the restart functionality.

Read more…
mus_scheme_derived_quantities_modulemus_scheme_derived_quantities_type_module.f90

This module contains data types, function and routines for gradient computation.

Read more…
mus_scheme_header_modulemus_scheme_header_module.f90

This module contains scheme property type and module related to scheme prop

Read more…
mus_scheme_layout_modulemus_scheme_layout_module.f90

scheme_layout module, providing the scheme_layout datatype and the functionality to read the lua files and to set the predefined stencils.

Read more…
mus_scheme_modulemus_scheme_module.f90

Definition of the datatypes for the scheme implementation.

Read more…
mus_scheme_type_modulemus_scheme_type_module.f90

This module contains the type definition(s) required in the scheme routines In addition depend type and condition type for geometry increase routine are defined. Compute kernel definition is also defined in this module

mus_solSpecHelpers_modulemus_solSpecHelpers_module.f90

This module provides MUSUBI specific helper functions for extracting information from the solver specific character.

mus_source_modulemus_source_module.f90

Module containing subroutines for initialize Musubi source variables and update source terms

mus_source_type_modulemus_source_type_module.f90

Module containing subroutines for building MUSUBI specific source variables

mus_source_var_modulemus_source_var_module.f90

Module containing subroutines for building MUSUBI specific source variables

mus_source_var_turbChanForce_modulemus_source_var_turbChanForce_module.f90

Module containing subroutines for building MUSUBI specific source variables for turbulent channel flow. To avoid cyclic inclusions

mus_species_modulemus_species_module.f90

This module contains mus_species_type and routines to load species table from config file.

mus_statistics_modulemus_statistics_module.f90

In this module we collect routines and type definitions related to statistics for the runtime of the code.

mus_time_modulemus_time_module.f90

This module contains time definition needed for musubi

mus_timer_modulemus_timer_module.f90

This module contains data types and routines used to measure time spend on musubi routines. author: Kannan Masilamani

mus_tools_modulemus_tools_module.f90

Some generic handy check routines to check the properties of the flow field and the current run

Read more…
mus_tracking_modulemus_tracking_module.f90

This module provides the MUSUBI subroutines needed for the tracking functionality.

mus_transport_var_modulemus_transport_var_module.f90

Module containing subroutines for building MUSUBI specific transport variables to use in compute kernels and source update

mus_turb_viscosity_modulemus_turb_viscosity_module.f90

This module assigns function pointer to calculate turbulent viscosity according to turbulence model and scheme definition

mus_turb_wallFunc_modulemus_turb_wallFunc_module.f90

This module contains turbulent wall function type and routines to calculate friction velocity and stream-wise velocity component.

Read more…
mus_turbulence_modulemus_turbulence_module.f90

This module contains data types, function and routines for turbulence model. Especially the routine to compute turbulent eddy viscosity for different turbulence model

Read more…
mus_variable_modulemus_variable_module.f90

This module provides all possible 'pure variables' (= no prefixes) for a given kind of simulation.

Read more…
mus_Vreman_modulemus_Vreman_module.f90

This module contains function to compute eddy viscosity using Vreman LES turbulence model. Vreman, A. W. (2004). An eddy-viscosity subgrid-scale model for turbulent shear flow: Algebraic theory and applications. Physics of Fluids, 16(10), 3670–3681. model. author: Kannan Masilamani

mus_WALE_modulemus_WALE_module.f90

This module contains function to compute eddy viscosity for Wall-Adapting Local Eddy-Viscosity turbulence model. This implementation follows the LES described by Weickert et al. Weickert, M., Teike, G., Schmidt, O., & Sommerfeld, M. (2010). Investigation of the LES WALE turbulence model within the lattice Boltzmann framework. Computers and Mathematics with Applications, 59(7), 2200–2214. author: Kannan Masilamani

mus_wall_function_abstract_modulemus_wall_function_abstract_module.f90

This module contains data types, function and routines for wall function computations.

Read more…
mus_wall_function_musker_modulemus_wall_function_musker_module.f90

This module contains data types, function and routines for wall function computations relative to Musker profile. Haussmann, Marc; BARRETO, Alejandro CLARO; KOUYI, Gislain LIPEME; Rivière, Nicolas; Nirschl, Hermann; Krause, Mathias J. (2019): Large-eddy simulation coupled with wall models for turbulent channel flows at high Reynolds numbers with a lattice Boltzmann method — Application to Coriolis mass flowmeter. In Computers & Mathematics with Applications 78 (10), pp. 3285–3302. DOI: 10.1016/j.camwa.2019.04.033.

Read more…
mus_wall_function_reichardt_modulemus_wall_function_reichardt_module.f90

This module contains data types, function and routines for wall function computations relative to Reichardt profile. Haussmann, Marc; BARRETO, Alejandro CLARO; KOUYI, Gislain LIPEME; Rivière, Nicolas; Nirschl, Hermann; Krause, Mathias J. (2019): Large-eddy simulation coupled with wall models for turbulent channel flows at high Reynolds numbers with a lattice Boltzmann method — Application to Coriolis mass flowmeter. In Computers & Mathematics with Applications 78 (10), pp. 3285–3302. DOI: 10.1016/j.camwa.2019.04.033.

Read more…
mus_wall_function_schmitt_modulemus_wall_function_schmitt_module.f90

This module contains data types, function and routines for wall function computations relative to Schmitt profile. Ref to following paper for Schmitt three layer equations. Haussmann, M. et al. (2019) ‘Large-eddy simulation coupled with wall models for turbulent channel flows at high Reynolds numbers with a lattice Boltzmann method — Application to Coriolis mass flowmeter’, Computers & Mathematics with Applications. Elsevier Ltd, 78(10), pp. 3285–3302.

Read more…
mus_weights_modulemus_weights_module.f90

This module include the routine required for element wie dumping weight for better load balancing. Dump weights at end of simulation if 'write_weights' is defined in the config file. Weights are based on element wise time measurements