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.

Please be patient as we add more capabilities and tutorials to the code. For now we have only a couple of tutorials.

Index

User Tutorials
Developer's manual
Lua 5.3 Reference
PETSc Documentation
Visualization Tool Kit (VTK) documentation
clang-tidy Documentation

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

Input Functions

1.1 MPI Utilities

chiMPIBarrier()

1.2 Logging Utilities

chiLog()

chiLogSetVerbosity()

chiLogProcessEvent()

1.3 Math Utilities

chiLegendre()

chiLegendreDerivative()

chiYlm()

1.4 Quadratures

chiCreateLineQuadrature()	chiCreateProductQuadrature()	chiCreateCylindricalProductQuadrature()
chiCreateSphericalProductQuadrature()	chiCreateCustomAngularQuadrature()	chiGetProductQuadrature()
chiCreateSLDFESQAngularQuadrature()	chiLocallyRefineSLDFESQAngularQuadrature()	chiPrintToPythonSLDFESQAngularQuadrature()
chiOptimizeAngularQuadratureForPolarSymmetry()

1.5 Orthogonal Meshes

chiMeshCreateUnpartitioned1DOrthoMesh()

chiMeshCreateUnpartitioned2DOrthoMesh()

chiMeshCreateUnpartitioned3DOrthoMesh()

1.6 Loading a Mesh from File

chiUnpartitionedMeshFromVTU()	chiUnpartitionedMeshFromEnsightGold()	chiUnpartitionedMeshFromWavefrontOBJ()
chiUnpartitionedMeshFromMshFormat()	chiUnpartitionedMeshFromExodusII()

1.7 Manual Unpartitioned Mesh

chiCreateEmptyUnpartitionedMesh()	chiUnpartitionedMeshUploadVertex()	chiUnpartitionedMeshUploadCell()
chiUnpartitionedMeshFinalizeEmpty()	chiDestroyUnpartitionedMesh()

1.8 Logical Volumes

chiLogicalVolumeCreate()

1.9 Mesh Handler

chiMeshHandlerCreate()	chiMeshHandlerSetCurrent()	chiMeshHandlerExportMeshToObj()
chiMeshHandlerExportMeshToVTK()

1.10 Surface Meshes

chiSurfaceMeshCreate()	chiSurfaceMeshImportFromOBJFile()	chiSurfaceMeshImportFromTriangleFiles()
chiSurfaceMeshExportToObj()	chiSurfaceMeshExportPolyFile()	chiSurfaceMeshCheckCycles()
chiComputeLoadBalancing()

1.11 Meshers

chiSurfaceMesherCreate()	chiSurfaceMesherExecute()	chiSurfaceMesherSetProperty()
chiVolumeMesherCreate()	chiVolumeMesherExecute()	chiVolumeMesherSetProperty()
chiVolumeMesherSetKBAPartitioningPxPyPz()	chiVolumeMesherSetKBACutsX()	chiVolumeMesherSetKBACutsY()
chiVolumeMesherSetKBACutsZ()	chiVolumeMesherSetMatIDToAll()	chiVolumeMesherSetupOrthogonalBoundaries()

1.12 Experimental

chiDecomposeSurfaceMeshPxPy()

chiCutMesh()

chiCountMeshInLogicalVolume()

1.13 Field-functions

chiGetFieldFunctionHandleByName()

chiExportFieldFunctionToVTK()

chiExportMultiFieldFunctionToVTK()

1.14 Field-function Manipulation

chiFFInterpolationCreate()	chiFFInterpolationSetProperty()	chiFFInterpolationInitialize()
chiFFInterpolationExecute()	chiFFInterpolationExportPython()	chiFFInterpolationGetValue()

1.15 Physics Utilities

chiSolverInitialize()	chiSolverExecute()	chiSolverSetBasicOption()
chiSolverStep()	chiSolverGetName()	chiSolverGetFieldFunctionList()
chiPhysicsAddMaterial()	chiPhysicsMaterialAddProperty()	chiPhysicsMaterialSetProperty()
chiPhysicsMaterialGetProperty()	chiPhysicsMaterialModifyTotalCrossSection()

1.16 Transport interaction cross-sections

Chi-Tech Cross-section format 1 Chi-Tech native cross-section file format

chiPhysicsTransportXSCreate()	chiPhysicsTransportXSSet()	chiPhysicsTransportXSMakeCombined()
chiPhysicsTransportXSGet()	chiPhysicsTransportXSExportToChiTechFormat()

Modules

2.1 Linear Boltzmann Solvers

Linear Boltzmann Solver Documentation page

DiscreteOrdinatesSolver

DiffusionDFEMSolver

chiLBSSetOptions()

Utilities

chiLBSGetScalarFieldFunctionList()	chiLBSWriteGroupsetAngularFlux()	chiLBSReadGroupsetAngularFlux()
chiLBSWriteFluxMoments()	chiLBSCreateAndWriteSourceMoments()	chiLBSReadFluxMomentsAndMakeSourceMoments()
chiLBSReadSourceMoments()	chiLBSReadFluxMoments()	chiLBSAddPointSource()
chiLBSClearPointSources()	chiLBSInitializePointSources()	chiLBSSetPhiFromFieldFunction()

Deprecated

chiLBSSetProperty()

Groupsets

Groupsets Main page

chiLBSCreateGroup()	chiLBSCreateGroupset()	chiLBSGroupsetAddGroups()
chiLBSGroupsetSetQuadrature()	chiLBSGroupsetSetAngleAggregationType()	chiLBSGroupsetSetAngleAggDiv()
chiLBSGroupsetSetGroupSubsets()	chiLBSGroupsetSetIterativeMethod()	chiLBSGroupsetSetResidualTolerance()
chiLBSGroupsetSetMaxIterations()	chiLBSGroupsetSetGMRESRestartIntvl()	chiLBSGroupsetSetEnableSweepLog()
chiLBSGroupsetSetWGDSA()	chiLBSGroupsetSetTGDSA()

Discrete Ordinates

DiscreteOrdinatesSolver

chiLBSComputeBalance()

chiLBSComputeLeakage()

LBS Adjoint SteadyStateSolver

chiAdjointSolverCreate()	chiAdjointSolverAddResponseFunction()	chiAdjointSolverMakeExpRepFromP1Moments()
chiAdjointSolverExportImportanceMapBinary()	chiAdjointSolverComputeInnerProduct()	chiAdjointSolverReadFluxMomentsToBuffer()
chiAdjointSolverApplyFluxMomentBuffer()

LBS Transient SteadyStateSolver

chiLBSCreateTransientSolver()	chiLBTSSetProperty()	chiLBTSGetProperty()
chiLBTSAdvanceTimeData()

2.2 Diffusion Solvers

Diffusion

chiDiffusionCreateSolver()	chiDiffusionInitialize()	chiDiffusionExecute()
chiDiffusionSetProperty()

2.3 Point Reactor Kinetics

Point Reactor Kinetics

prk.TransientSolver

2.4 Test scripts

chiSimTest01_FV()	chiSimTest02_FV()	chiSimTest03_PWLC()
chiSimTest04_PWLC()	chiSimTest06_WDD()	chiSimTest91_PWLD()
chiSimTest92_DSA()	chiSimTest93_RayTracing()	chiSimTest93_RayTracing()
chiSimTest_IP_MMS_L2error()	chiLuaTest()

This file was generated using the script: doc/scripts/MakeMainPage.py

Table of Contents