test_rtin_pct.m
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% This file has been generated by NS2DDV routine generate_setup_file.m %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% This part has been automatically generated: please do not modify it !
% The parameters you can modify are located at the end of this file
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
PARAMETERS.PARALLELIZATION.SERVER = 'LOCAL';
PARAMETERS.MODEL = 'NSDV';
PARAMETERS.TESTCASE = 'RTIN';
PARAMETERS.CV_STUDY = 'NONE';
PARAMETERS.DOMAIN.GEOMETRY = 'RECTANGLE';
PARAMETERS.FV.SCHEME = 'MUSCL';
PARAMETERS.PARALLELIZATION.TOOLBOX = 'PCT';
localcluster = parcluster('local');
PARAMETERS.LINSYS.DIRECT_INVERSION = 'YES';
PARAMETERS.MESH.ADAPTATIVE = 'NO';
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% From this line, you can modify the values of the parameters
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Domain parameters
%%%%%%%%%%%%%%%%%%%
% Parameters for a RECTANGLE domain (default = [-0.5,0.5]x[-2,2])
PARAMETERS.DOMAIN.XMIN = -0.5;
PARAMETERS.DOMAIN.XMAX = 0.5;
PARAMETERS.DOMAIN.YMIN = -2;
PARAMETERS.DOMAIN.YMAX = 2;
% Physical parameters
%%%%%%%%%%%%%%%%%%%%%
% Viscosity kind
% 'CONST' Constant viscosity
PARAMETERS.PHYSICAL.VISCOSITY = 'CONST';
% Final time
PARAMETERS.FINAL_TIME = 0.2;
% Reynolds number
PARAMETERS.PHYSICAL.RE = 1000.;
% Gravity amplitude (Default = 9.81)
PARAMETERS.PHYSICAL.GRAVITY = 9.81;
% Characteristic density of the light fluid
PARAMETERS.PHYSICAL.RHOMIN = 1.;
% Characteristic density of the heavy fluid
PARAMETERS.PHYSICAL.RHOMAX = 7.;
% Initialization with external data
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Use a third-party file to initialize the simulation
% Allowed formats: '', 'xxx.h5', 'xxx.mat'
% If '' (default value) is selected, the simulation will be initialized with the test case parameters
% If a valid file is selected, some domain and physical parameters above will be ignored.
PARAMETERS.INIT_FILE = '';
% Build a new mesh at initialization (ignored if PARAMETERS.INIT_FILE = '')
% Allowed values: 'YES' or 'NO' (default)
PARAMETERS.REMESH = 'NO';
% Use domain parameters from the third-party initialization file or PARAMETERS.DOMAIN.XXX
% (ignored if PARAMETERS.INIT_FILE = '' or PARAMETERS.REMESH = 'NO')
% 'EXT_FILE' The domain geometry parameters are imposed by the contents of PARAMETERS.INIT_FILE
% 'CURRENT_FILE' Use the variables PARAMETERS.DOMAIN.XXX below
PARAMETERS.WHICH_GEOMETRY = 'EXT_FILE';
% Reset time variable if a third-party file is used to initialize the simulation (ignored if PARAMETERS.INIT_FILE = '')
% Allowed values: 'YES' (default) or 'NO'
PARAMETERS.RESET_TIME = 'YES';
% Mesh parameters
%%%%%%%%%%%%%%%%%
% Method for generating the space mesh
% 'PDET' Use the Matlab PDE toolbox
% 'NS2DDV' Use the routines embedded in NS2DDV code
% 'FROM_FILE' Load data from a mesh file (.msh or .p1/.t1 format allowed)
PARAMETERS.MESH.GENERATION = 'NS2DDV';
% Node renumbering method
% 'NONE' No renumbering
% 'AMD' Renumbering with Minimum Degree Algorithm Matlab built-in routines
% 'CMK' Renumbering with Cuthill-McKee Matlab built-in routines
PARAMETERS.MESH.RENUMBERING = 'NONE';
% Parameters for a NS2DDV mesh
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Design of structured mesh ('DIAGONAL' or 'CROSS')
PARAMETERS.MESH.TRIANGLES_ORIENTATION = 'DIAGONAL';
% Number of edges on North and South bounds
% WARNING: it must be a multiple of 2
PARAMETERS.MESH.NBSEG_X = 10;
% Number of edges on West and East bounds
% WARNING: it must be a multiple of 4 if PARAMETERS.MESH.TRIANGLE_ORIENTATION = 'DIAGONAL', and a multiple of 2 else
PARAMETERS.MESH.NBSEG_Y = 40;
% Parameters for a PDET mesh
%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Characteristic edge length in the mesh
PARAMETERS.MESH.H0 = 0.1;
% Parameters for a FROM_FILE mesh
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Mesh source file(s) : .msh or .p1/.t1 format allowed
% {'xxxx.msh'} cell array of size 1 for .msh format
% {'xxxx.p1', 'xxxx.t1'} cell array of size 2 for .p1/.t1 format
PARAMETERS.MESH.SRC_FILES = {};
% Rescale the mesh to fit with the domain geometry above ('YES' or 'NO')
PARAMETERS.MESH.RESCALE = 'NO';
% Boundary condition parameters for velocity
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% 'DIRICHLET' Use Dirichlet boundary condition on the specified part of the boundary
% 'NEUMANN' Use Neumann boundary condition on the specified part of the boundary
% Boundary condition on the bottom bound for ux (allowed values: 'DIRICHLET')
PARAMETERS.FE.BC_BOTTOM_UX = 'DIRICHLET';
% Boundary condition on the bottom bound for uy (allowed values: 'DIRICHLET')
PARAMETERS.FE.BC_BOTTOM_UY = 'DIRICHLET';
% Boundary condition on the top bound for ux (allowed values: 'DIRICHLET')
PARAMETERS.FE.BC_TOP_UX = 'DIRICHLET';
% Boundary condition on the top bound for uy (allowed values: 'DIRICHLET')
PARAMETERS.FE.BC_TOP_UY = 'DIRICHLET';
% Boundary condition on the left bound for ux (allowed values: 'SYMMETRY')
PARAMETERS.FE.BC_LEFT_UX = 'SYMMETRY';
% Boundary condition on the left bound for uy (allowed values: 'SYMMETRY')
PARAMETERS.FE.BC_LEFT_UY = 'SYMMETRY';
% Boundary condition on the right bound for ux (allowed values: 'SYMMETRY')
PARAMETERS.FE.BC_RIGHT_UX = 'SYMMETRY';
% Boundary condition on the right bound for uy (allowed values: 'SYMMETRY')
PARAMETERS.FE.BC_RIGHT_UY = 'SYMMETRY';
% Finite Element parameters
%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Time semi-discretization of the Stokes equation
% 'BDF2' Implicit 2-steps Backward Differentiation Formula
% 'BDF2_PROJ' Implicit 2-steps Backward Differentiation Formula + Projection method
% 'BDF2_PROJ_VAR' Implicit 2-steps Backward Differentiation Formula + Projection method with variable density
PARAMETERS.FE.SCHEME = 'BDF2';
% Amplitude of the rotational term in the pressure correction for 'BDF2_PROJ*' methods
PARAMETERS.FE.ROT_CORRECTION = 0.5/PARAMETERS.PHYSICAL.RE;
% Space discretization of velocity
% 'P1B' P1-bubble finite elements approximation
% 'P2' P2 finite elements approximation
PARAMETERS.FE.TYPE = 'P2';
% Space discretization of density in Stokes equation
% 'P1' P1 finite elements approximation
PARAMETERS.FE.TYPE_DENSITY = 'P1';
% Constrain for closing the pressure problem
% 'ZERO_FIXED_POINT' p = 0 is imposed on a specific point in the space domain
% 'ZERO_AVERAGE' the average of p is set to 0 within the discrete system
% 'ZERO_AVERAGE_APOSTERIORI' the average of p is set to 0 as an a posteriori constrain (only works with PARAMETERS.FE.SCHEME = 'BDF2')
PARAMETERS.FE.PRESSURE_CONSTRAIN = 'ZERO_FIXED_POINT';
% Coordinates of the null pressure point
% WARNING: if the domain geometry parameters are obtained from an external file, it is not recommended to use
% the variables PARAMETERS.DOMAIN.XXX to define the coordinates of the null pressure point. Use numerical values instead
PARAMETERS.FE.NFX_X = 0.5*(PARAMETERS.DOMAIN.XMIN+PARAMETERS.DOMAIN.XMAX);
PARAMETERS.FE.NFX_Y = 0.75*PARAMETERS.DOMAIN.YMAX+0.25*PARAMETERS.DOMAIN.YMIN;
% Time step for solving Stokes equation
% WARNING : this time step is of the form Cmax*hmax^alphamax + Cmin*hmin^alphamin
% where hmax (hmin) is the max (min) length of an edge
% Value of alphamax
PARAMETERS.FE.ALPHAMAX_STEP_TIME = 1.5;
% Value of alphamin
PARAMETERS.FE.ALPHAMIN_STEP_TIME = 1.5;
% Value of Cmax
PARAMETERS.FE.CMAX_STEP_TIME = 0;
% Value of Cmin
PARAMETERS.FE.CMIN_STEP_TIME = 1;
% Reduce the time step to reach the final time T exactly ('YES' or 'NO')
% Warning: answering 'NO' will probably make the simulation stop a little before the final time
PARAMETERS.FE.FIT_STEP_TIME = 'YES';
% Time splitting
% 1 1st order Lie splitting
% 2 2nd order symmetric Strang splitting
PARAMETERS.TIME_SPLITTING = 2;
% Finite Volume parameters
%%%%%%%%%%%%%%%%%%%%%%%%%%
% Shape of dual cells (node-centered)
% (a dual cell is centered on a node and its bound is obtained by connecting the
% middle point of edges that start from the node and the neighbour cells control points)
%'STARS' The cell control points are the barycenters
%'SQUARES' The cell control points are the orthocenters (works only with PARAMETERS.MESH.GENERATION = 'NS2DDV')
PARAMETERS.FV.CELLS_DESIGN = 'STARS';
% Gradient reconstruction method
%'PRECEEDING' Use the gradient on the upstream cell
%'SURROUNDING' Use an average of the gradient on the neighbour cells
% WARNING: this parameter is ignored if PARAMETERS.FV.CELLS_DESIGN = 'SQUARES'
PARAMETERS.FV.GRADIENT_COMPUTING = 'PRECEEDING';
% Beta parameter in gradient reconstruction (should be in [0,1]; default value = 1/3)
PARAMETERS.FV.BETA = 1./3.;
% Flux limiter method
% 'NOLIM' No flux limiter
% 'STDLIM' Mono-slope flux limiter
% 'TAULIM' Multi-slope flux limiter (only with PARAMETERS.FV.CELLS_DESIGN = 'STARS' and PARAMETERS.FV.GRADIENT_COMPUTING = 'PRECEEDING')
PARAMETERS.FV.FLUX_LIMITER = 'TAULIM';
% Flux limiter function (ignored if PARAMETERS.FV.FLUX_LIMITER = 'NONE')
% 'MINMOD' Min-Mod limiter
% 'VANLEER' Van Leer limiter
% 'SUPERBEE' Super-bee limiter (only with PARAMETERS.FV.FLUX_LIMITER = 'STDLIM')
% 'VANALBADA' Van Albada limiter (only with PARAMETERS.FV.FLUX_LIMITER = 'STDLIM')
PARAMETERS.FV.FLUX_LIMITER_FUNCTION = 'VANLEER';
% Flux limiter usage threshold (ignored if PARAMETERS.FV.FLUX_LIMITER = 'NONE')
PARAMETERS.FV.EPSILON = 1.000000e-06;
% Parallelization parameters
%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Number of CPU workers (default value = localcluster.NumWorkers)
PARAMETERS.PARALLELIZATION.NBWORKERS = localcluster.NumWorkers;
% Visualization parameters
%%%%%%%%%%%%%%%%%%%%%%%%%%
% Display 2D results in a Matlab graphical window :
% 'SINGLE_FIGURE' All graphical outputs in a unique figure
% 'MULTIPLE_FIGURE' One graphical output per figure, stable
% 'NONE' No graphical output
PARAMETERS.OUTPUT.XDISPLAY = 'SINGLE_FIGURE';
% Refreshing frequency for 2D graphical display (default = 1)
PARAMETERS.OUTPUT.XDISPLAY_FREQUENCY = 1;
% List of 2D results to be plotted :
% 'MESH' The P1 mesh
% 'SUBTRI_U' The subtriangulation for velocity (either P2 or P1B)
% 'RHO' The density isovalues
% 'U_VECTOR' The velocity vector field
% 'UX' The isovalues of the x-component of velocity
% 'UY' The isovalues of the y-component of velocity
% 'UX_DX' The isovalues of the x-derivative of the x-component of velocity
% 'UX_DY' The isovalues of the y-derivative of the x-component of velocity
% 'UY_DX' The isovalues of the x-derivative of the y-component of velocity
% 'UY_DY' The isovalues of the y-derivative of the y-component of velocity
% 'SHEAR' The isovalues of the shear rate
% 'U_MODULE' The velocity magnitude isovalues
% 'VORTIC' The vorticity isovalues
% 'STREAM' The velocity streamlines
% 'P' The pressure isovalues
% 'GRAD_P' The pressure gradient
% 'P_DX' The isovalues of the x-derivative of pressure
% 'P_DY' The isovalues of the y-derivative of pressure
PARAMETERS.OUTPUT.XDISPLAY_LIST = {'MESH', 'RHO', 'U_VECTOR'};
% Output parameters
%%%%%%%%%%%%%%%%%%%
% Directory for numerical results
PARAMETERS.OUTPUT.DIRECTORY_NAME = './RESULTS/EXAMPLES/test_rtin';
% Name of output file(s)
PARAMETERS.OUTPUT.FILE_NAME = 'diags';
% Save method of these results :
% 'LAST_FRAME' The solution is only saved at final time
% 'ANIMATION' If time dynamics is considered, an animated result is saved
% 'NONE' Only the log file is saved
PARAMETERS.OUTPUT.XDISPLAY_SAVE = 'ANIMATION';
% Refreshing frequency for save 2D results (default = 1)
PARAMETERS.OUTPUT.XDISPLAY_SAVE_FREQUENCY = 1;
% List of optional diagnostics
PARAMETERS.OUTPUT.XDISPLAY_SAVE_OPTDIAGS = {};
% Backup parameters
%%%%%%%%%%%%%%%%%%%
% Number of backup files (default = 1)
% Each backup file contains the required data to restart the code after a critical crash
PARAMETERS.BACKUP.NB_FILES = 1;
% Backup frequency (default = 10)
PARAMETERS.BACKUP.FREQUENCY = 10;
% Backup file location
PARAMETERS.BACKUP.DIRECTORY_NAME = './BACKUP/EXAMPLES/test_rtin';
