MainPage.h

Go to the documentation of this file.

/** \mainpage
 
ChiTech is an engineering development platform under development to support
various scientific simulations. At the core of the platform is the **Lua**
scripting engine which allows the user to interact with their C++ code using
a script-environment.\n
\n
Please be patient as we add more capabilities and tutorials to the code. For
now we have only a couple of tutorials.\n
\n
 
 # Index
 
 \subpage Tutorial00 \n
 \subpage ProgrammerManual \n
 <a href="https://www.lua.org/manual/5.3/"><B>Lua 5.3 Reference</B></a>\n
 <a href="https://www.mcs.anl.gov/petsc/documentation/index.html"><B>PETSc Documentation</B></a>\n
 <a href="https://lorensen.github.io/VTKExamples/site/"><B>Visualization Tool Kit (VTK) documentation</B></a>\n
 <a href="https://clang.llvm.org/extra/clang-tidy/#suppressing-undesired-diagnostics"><B>clang-tidy Documentation</B></a>
 
\n
 
\tableofcontents
 
# Variables defined in lua
Variable Name        | Description                            | Variable Name        | Description
---------------------|------------------                      |--------------------- |---------------------
 `chi_version`       | Version string, e.g., "1.2.3"          | `chi_minor_version`  | Minor version, e.g., 2, as an integer
 `chi_major_version` | Major version, e.g., 1, as an integer  | `chi_patch_version`  | Patch version, e.g., 3, as an integer
 `chi_location_id`   | Current process rank in MPI-context    | `chi_number_of_processes` | Number of MPI processes
 
\n
 
 
 \section MainPage1 Input Functions
 
\subsection MainPage1_1 1.1 MPI Utilities
<table>
<tr>
<td width="33%">chiMPIBarrier()</td>
</tr>
</table>
 
\subsection MainPage1_2 1.2 Logging Utilities
<table>
<tr>
<td width="33%">chiLog()</td>
<td width="33%">chiLogSetVerbosity()</td>
<td width="33%">chiLogProcessEvent()</td>
</tr>
<tr>
</tr>
</table>
 
\subsection MainPage1_3 1.3 Math Utilities
<table>
<tr>
<td width="33%">chiLegendre()</td>
<td width="33%">chiLegendreDerivative()</td>
<td width="33%">chiYlm()</td>
</tr>
<tr>
</tr>
</table>
 
\subsection MainPage1_4 1.4 Quadratures
<table>
<tr>
<td width="33%">chiCreateLineQuadrature()</td>
<td width="33%">chiCreateProductQuadrature()</td>
<td width="33%">chiCreateCylindricalProductQuadrature()</td>
</tr>
<tr>
<td width="33%">chiCreateSphericalProductQuadrature()</td>
<td width="33%">chiCreateCustomAngularQuadrature()</td>
<td width="33%">chiGetProductQuadrature()</td>
</tr>
<tr>
<td width="33%">chiCreateSLDFESQAngularQuadrature()</td>
<td width="33%">chiLocallyRefineSLDFESQAngularQuadrature()</td>
<td width="33%">chiPrintToPythonSLDFESQAngularQuadrature()</td>
</tr>
<tr>
<td width="33%">chiOptimizeAngularQuadratureForPolarSymmetry()</td>
</tr>
</table>
 
\subsection MainPage1_5 1.5 Orthogonal Meshes
<table>
<tr>
<td width="33%">chiMeshCreateUnpartitioned1DOrthoMesh()</td>
<td width="33%">chiMeshCreateUnpartitioned2DOrthoMesh()</td>
<td width="33%">chiMeshCreateUnpartitioned3DOrthoMesh()</td>
</tr>
<tr>
</tr>
</table>
 
\subsection MainPage1_6 1.6 Loading a Mesh from File
<table>
<tr>
<td width="33%">chiUnpartitionedMeshFromVTU()</td>
<td width="33%">chiUnpartitionedMeshFromEnsightGold()</td>
<td width="33%">chiUnpartitionedMeshFromWavefrontOBJ()</td>
</tr>
<tr>
<td width="33%">chiUnpartitionedMeshFromMshFormat()</td>
<td width="33%">chiUnpartitionedMeshFromExodusII()</td>
</tr>
</table>
 
\subsection MainPage1_7 1.7 Manual Unpartitioned Mesh
<table>
<tr>
<td width="33%">chiCreateEmptyUnpartitionedMesh()</td>
<td width="33%">chiUnpartitionedMeshUploadVertex()</td>
<td width="33%">chiUnpartitionedMeshUploadCell()</td>
</tr>
<tr>
<td width="33%">chiUnpartitionedMeshFinalizeEmpty()</td>
<td width="33%">chiDestroyUnpartitionedMesh()</td>
</tr>
</table>
 
\subsection MainPage1_8 1.8 Logical Volumes
<table>
<tr>
<td width="33%">chiLogicalVolumeCreate()</td>
</tr>
</table>
 
\subsection MainPage1_9 1.9 Mesh Handler
<table>
<tr>
<td width="33%">chiMeshHandlerCreate()</td>
<td width="33%">chiMeshHandlerSetCurrent()</td>
<td width="33%">chiMeshHandlerExportMeshToObj()</td>
</tr>
<tr>
<td width="33%">chiMeshHandlerExportMeshToVTK()</td>
</tr>
</table>
 
\subsection MainPage1_10 1.10 Surface Meshes
<table>
<tr>
<td width="33%">chiSurfaceMeshCreate()</td>
<td width="33%">chiSurfaceMeshImportFromOBJFile()</td>
<td width="33%">chiSurfaceMeshImportFromTriangleFiles()</td>
</tr>
<tr>
<td width="33%">chiSurfaceMeshExportToObj()</td>
<td width="33%">chiSurfaceMeshExportPolyFile()</td>
<td width="33%">chiSurfaceMeshCheckCycles()</td>
</tr>
<tr>
<td width="33%">chiComputeLoadBalancing()</td>
</tr>
</table>
 
\subsection MainPage1_11 1.11 Meshers
<table>
<tr>
<td width="33%">chiSurfaceMesherCreate()</td>
<td width="33%">chiSurfaceMesherExecute()</td>
<td width="33%">chiSurfaceMesherSetProperty()</td>
</tr>
<tr>
<td width="33%">chiVolumeMesherCreate()</td>
<td width="33%">chiVolumeMesherExecute()</td>
<td width="33%">chiVolumeMesherSetProperty()</td>
</tr>
<tr>
<td width="33%">chiVolumeMesherSetKBAPartitioningPxPyPz()</td>
<td width="33%">chiVolumeMesherSetKBACutsX()</td>
<td width="33%">chiVolumeMesherSetKBACutsY()</td>
</tr>
<tr>
<td width="33%">chiVolumeMesherSetKBACutsZ()</td>
<td width="33%">chiVolumeMesherSetMatIDToAll()</td>
<td width="33%">chiVolumeMesherSetupOrthogonalBoundaries()</td>
</tr>
<tr>
</tr>
</table>
 
\subsection MainPage1_12 1.12 Experimental
<table>
<tr>
<td width="33%">chiDecomposeSurfaceMeshPxPy()</td>
<td width="33%">chiCutMesh()</td>
<td width="33%">chiCountMeshInLogicalVolume()</td>
</tr>
<tr>
</tr>
</table>
 
\subsection MainPage1_13 1.13 Field-functions
<table>
<tr>
<td width="33%">chiGetFieldFunctionHandleByName()</td>
<td width="33%">chiExportFieldFunctionToVTK()</td>
<td width="33%">chiExportMultiFieldFunctionToVTK()</td>
</tr>
<tr>
</tr>
</table>
 
\subsection MainPage1_14 1.14 Field-function Manipulation
<table>
<tr>
<td width="33%">chiFFInterpolationCreate()</td>
<td width="33%">chiFFInterpolationSetProperty()</td>
<td width="33%">chiFFInterpolationInitialize()</td>
</tr>
<tr>
<td width="33%">chiFFInterpolationExecute()</td>
<td width="33%">chiFFInterpolationExportPython()</td>
<td width="33%">chiFFInterpolationGetValue()</td>
</tr>
<tr>
</tr>
</table>
 
\subsection MainPage1_15 1.15 Physics Utilities
<table>
<tr>
<td width="33%">chiSolverInitialize()</td>
<td width="33%">chiSolverExecute()</td>
<td width="33%">chiSolverSetBasicOption()</td>
</tr>
<tr>
<td width="33%">chiSolverStep()</td>
<td width="33%">chiSolverGetName()</td>
<td width="33%">chiSolverGetFieldFunctionList()</td>
</tr>
<tr>
<td width="33%">chiPhysicsAddMaterial()</td>
<td width="33%">chiPhysicsMaterialAddProperty()</td>
<td width="33%">chiPhysicsMaterialSetProperty()</td>
</tr>
<tr>
<td width="33%">chiPhysicsMaterialGetProperty()</td>
<td width="33%">chiPhysicsMaterialModifyTotalCrossSection()</td>
</tr>
</table>
 
\subsection MainPage1_16 1.16 Transport interaction cross-sections
\ref ChiXSFile Chi-Tech native cross-section file format
 
<table>
<tr>
<td width="33%">chiPhysicsTransportXSCreate()</td>
<td width="33%">chiPhysicsTransportXSSet()</td>
<td width="33%">chiPhysicsTransportXSMakeCombined()</td>
</tr>
<tr>
<td width="33%">chiPhysicsTransportXSGet()</td>
<td width="33%">chiPhysicsTransportXSExportToChiTechFormat()</td>
</tr>
</table>
 
\section MainPage2 Modules
 
\subsection MainPage2_1 2.1 Linear Boltzmann Solvers
\ref LuaLBS Documentation page
 
<table>
<tr>
<td width="33%">\ref lbs__DiscreteOrdinatesSolver()</td>
<td width="33%">\ref lbs__DiffusionDFEMSolver()</td>
<td width="33%">chiLBSSetOptions()</td>
</tr>
<tr>
</tr>
</table>
 
\subsubsection MainPage2_2_1 Utilities
<table>
<tr>
<td width="33%">chiLBSGetScalarFieldFunctionList()</td>
<td width="33%">chiLBSWriteGroupsetAngularFlux()</td>
<td width="33%">chiLBSReadGroupsetAngularFlux()</td>
</tr>
<tr>
<td width="33%">chiLBSWriteFluxMoments()</td>
<td width="33%">chiLBSCreateAndWriteSourceMoments()</td>
<td width="33%">chiLBSReadFluxMomentsAndMakeSourceMoments()</td>
</tr>
<tr>
<td width="33%">chiLBSReadSourceMoments()</td>
<td width="33%">chiLBSReadFluxMoments()</td>
<td width="33%">chiLBSAddPointSource()</td>
</tr>
<tr>
<td width="33%">chiLBSClearPointSources()</td>
<td width="33%">chiLBSInitializePointSources()</td>
<td width="33%">chiLBSSetPhiFromFieldFunction()</td>
</tr>
<tr>
</tr>
</table>
 
\subsubsection MainPage2_2_2 Deprecated
<table>
<tr>
<td width="33%">chiLBSSetProperty()</td>
</tr>
</table>
 
\subsubsection MainPage2_2_3 Groupsets
\ref LuaLBSGroupsets Main page
 
<table>
<tr>
<td width="33%">chiLBSCreateGroup()</td>
<td width="33%">chiLBSCreateGroupset()</td>
<td width="33%">chiLBSGroupsetAddGroups()</td>
</tr>
<tr>
<td width="33%">chiLBSGroupsetSetQuadrature()</td>
<td width="33%">chiLBSGroupsetSetAngleAggregationType()</td>
<td width="33%">chiLBSGroupsetSetAngleAggDiv()</td>
</tr>
<tr>
<td width="33%">chiLBSGroupsetSetGroupSubsets()</td>
<td width="33%">chiLBSGroupsetSetIterativeMethod()</td>
<td width="33%">chiLBSGroupsetSetResidualTolerance()</td>
</tr>
<tr>
<td width="33%">chiLBSGroupsetSetMaxIterations()</td>
<td width="33%">chiLBSGroupsetSetGMRESRestartIntvl()</td>
<td width="33%">chiLBSGroupsetSetEnableSweepLog()</td>
</tr>
<tr>
<td width="33%">chiLBSGroupsetSetWGDSA()</td>
<td width="33%">chiLBSGroupsetSetTGDSA()</td>
</tr>
</table>
 
\subsubsection MainPage2_2_4 Discrete Ordinates
<table>
<tr>
<td width="33%">\ref lbs__DiscreteOrdinatesSolver()</td>
<td width="33%">chiLBSComputeBalance()</td>
<td width="33%">chiLBSComputeLeakage()</td>
</tr>
<tr>
</tr>
</table>
 
\subsubsection MainPage2_2_5 LBS Adjoint SteadyStateSolver
<table>
<tr>
<td width="33%">chiAdjointSolverCreate()</td>
<td width="33%">chiAdjointSolverAddResponseFunction()</td>
<td width="33%">chiAdjointSolverMakeExpRepFromP1Moments()</td>
</tr>
<tr>
<td width="33%">chiAdjointSolverExportImportanceMapBinary()</td>
<td width="33%">chiAdjointSolverComputeInnerProduct()</td>
<td width="33%">chiAdjointSolverReadFluxMomentsToBuffer()</td>
</tr>
<tr>
<td width="33%">chiAdjointSolverApplyFluxMomentBuffer()</td>
</tr>
</table>
 
\subsubsection MainPage2_2_6 LBS Transient SteadyStateSolver
<table>
<tr>
<td width="33%">chiLBSCreateTransientSolver()</td>
<td width="33%">chiLBTSSetProperty()</td>
<td width="33%">chiLBTSGetProperty()</td>
</tr>
<tr>
<td width="33%">chiLBTSAdvanceTimeData()</td>
</tr>
</table>
 
\subsection MainPage2_2 2.2 Diffusion Solvers
\subsubsection MainPage2_3_7 Diffusion
<table>
<tr>
<td width="33%">chiDiffusionCreateSolver()</td>
<td width="33%">chiDiffusionInitialize()</td>
<td width="33%">chiDiffusionExecute()</td>
</tr>
<tr>
<td width="33%">chiDiffusionSetProperty()</td>
</tr>
</table>
 
\subsubsection MainPage2_3_8 CFEM Diffusion solver
<table>
<tr>
<td width="33%">chiCFEMDiffusionSolverCreate()</td>
<td width="33%">chiCFEMDiffusionSetBCProperty()</td>
</tr>
</table>
 
\subsubsection MainPage2_3_9 DFEM Diffusion solver
<table>
<tr>
<td width="33%">chiDFEMDiffusionSolverCreate()</td>
<td width="33%">chiDFEMDiffusionSetBCProperty()</td>
</tr>
</table>
 
\subsubsection MainPage2_3_10 Finite Volume Diffusion solver
<table>
<tr>
<td width="33%">chiFVDiffusionSolverCreate()</td>
<td width="33%">chiFVDiffusionSetBCProperty()</td>
</tr>
</table>
 
\subsubsection MainPage2_3_11 CFEM Multigroup Diffusion solver
<table>
<tr>
<td width="33%">chiCFEMMGDiffusionSolverCreate()</td>
<td width="33%">chiCFEMMGDiffusionSetBCProperty()</td>
</tr>
</table>
 
\subsection MainPage2_3 2.3 Point Reactor Kinetics
\ref prk
 
- \ref prk__TransientSolver
 
\subsection MainPage2_4 2.4 Test scripts
<table>
<tr>
<td width="33%">chiSimTest01_FV()</td>
<td width="33%">chiSimTest02_FV()</td>
<td width="33%">chiSimTest03_PWLC()</td>
</tr>
<tr>
<td width="33%">chiSimTest04_PWLC()</td>
<td width="33%">chiSimTest06_WDD()</td>
<td width="33%">chiSimTest91_PWLD()</td>
</tr>
<tr>
<td width="33%">chiSimTest92_DSA()</td>
<td width="33%">chiSimTest93_RayTracing()</td>
<td width="33%">chiSimTest93_RayTracing()</td>
</tr>
<tr>
<td width="33%">chiSimTest_IP_MMS_L2error()</td>
<td width="33%">chiLuaTest()</td>
</tr>
</table>
 
This file was generated using the script: doc/scripts/MakeMainPage.py
 
 
*/