ICFERST  22-06
Reservoir simulator based on DCVFEM, Dynamic Mesh optimisation and Surface-based modelling
Data Types List
Here are the data types with brief descriptions:
[detail level 12]
 Ncv_advectionThis module contains all the tools to assemble and solve the equations and fields associated with the CV mesh, i.e. transport equation, continuity equation, DCVFE gradient matrix and the Laplacian system for the zeta-potential
 Cdg_derivs_allCalculates derivatives of vector fields
 Cpack_loc_allPacks field together to be later on used for high order computations
 Nmulti_data_typesThis module contains all the ICFERST structures and associated subroutines (allocate/deallocate) Use it also to identify what a variable means since here they are described
 Callocate_multi_dev_shape_funsAllocates the required memory to store the derivatives of the shape functions
 Callocate_multi_fieldAllocated a multi field type based on field name
 Cmulti_absorptionComprises all the absorption terms that migth be required
 Cmulti_dev_shape_funsData structure to store the derivatives of the shape functions and conversors from reference element to local
 Cmulti_dimensionsData type storing all the dimensionrs describing the mesh, fields, nodes, etc
 Cmulti_discretization_optsThis type includes the necessary information to choose from the different discretization options available They are a mistery even for the most advanced wizards of the realm... hopefully they can be removed in the future These parameters represent the degree of discretisation used, they are in general hardcoded based on the precision requested by the user so as said, to be removed in the future hopefully
 Cmulti_fieldType created to store absorption terms in a compacted way associated subroutines where created to be used with these fields
 Cmulti_gi_dimensionsNecessary information for perform gauss integration
 Cmulti_matricesThis type contains all the necessary information to solve =systems, matrices, RHS, limiters, colouring and also flags to decide which sort of matrices are generated
 Cmulti_ndglnThis type contains all the local to global conversors for the different fields we have
 Cmulti_outfluxesContains variables to analyse the flux across the BCs that the user is interested
 Cmulti_pipe_packageContains all the information required to model pipes. Many of these fields are unnecessary or even undesired..
 Cmulti_shape_funsData structure to store all the shape functions to facilitate its movement throughtout the code
 Cmulti_sparsitiesThis data type contains all the sparsities necessary in the multiphase prototype code
 Cmulti_sparsityThis type comprises the necessary variables to represent matrices using a CSR structure
 Cmulti_transport_scalarContains all the information for generic scalar fields to solve for
 Cpipe_coordsType containing everything required to indentify and store which nodes contain a well/pipe
 Cporous_adv_coefsRequired values to compute the fluxes for porous media. Effectively the sigma terms from the papers Currently they are oversized since apart from the permeability they are not tensors, this should be changed!
 Nsetbasicfortrancallbackf
 Cfcn
 Nshape_functions_linear_quadraticShape function subroutines for multi-dimensions for Quadrilaterals, Triangles, Hexaedra and Tetrahedra
 Cdetnlxr: Calculates the derivatives of the shape functions
 Cdetnlxr_invjac: Computes the derivatives of the shape functions and the inverse of the Jacobian
 Nshape_functions_ndimThis module contains subroutines to generate the shape functions for multi dimensions
 CxprodPerforms the cross product of two vectors
 Nshape_functions_prototypeSHAPE FUNCTIONS SUBRTS
 Cdetnlxr_plus_uSubroutine to compute the derivatives of the inputed shape functions
 Nxgb_interfaceInterface to call XGBoost library C API from fortran
 Cfortran_XGBoosterCreateCreate xgboost learner Returns 0 when success, -1 when failure happens
 Cfortran_XGBoosterFreeFree obj in handle Returns 0 when success, -1 when failure happens
 Cfortran_XGBoosterLoadModelLoad model from existing file. Returns 0 when success, -1 when failure happens
 Cfortran_XGBoosterPredictMake prediction based on dmatrix Returns 0 when success, -1 when failure happens
 Cfortran_XGBoosterSaveModelSave model into existing file. Returns 0 when success, -1 when failure happens
 Cfortran_XGBoosterSetParamSet Booster parameters Returns 0 when success, -1 when failure happens
 Cfortran_XGDMatrixCreateFromMatCreate matrix content from dense matrix Returns 0 when success, -1 when failure happens
 CSetBasicFortranCallbackF