Chi-Tech
D Output and Logging

Functions

void chi_lua::chiLogSetVerbosity (int int_level)
 
void chi_lua::chiLog (int LogType, char LogMsg)
 
double chi_lua::chiLogProcessEvent (string event_name, string event_operation_name)
 
void chi_lua::chiLogPrintTimingGraph (int rank)
 

Detailed Description

Function Documentation

◆ chiLog()

void chi_lua::chiLog ( int  LogType,
char  LogMsg 
)

Logs a message depending on the log type specified.

Parameters
LogTypeint Can be any of the log types specified below.
LogMsgchar Message or value to be output to the log.

_

LogType

LOG_0
Write a log only if location 0.
LOG_0WARNING
Write a log only if location 0 and format it as a warning.
LOG_0ERROR
Write a log only if location 0 and format it as an error.
LOG_0VERBOSE_0
Same as LOG_0.
LOG_0VERBOSE_1
Write a log only if location 0 and the verbosity level is greater or equal to 1.
LOG_0VERBOSE_2
Write a log only if location 0 and the verbosity level is greater or equal to 1.
LOG_ALL, LOG_ALLWARNING, LOG_ALLERROR,
LOG_ALLVERBOSE_0, LOG_ALLVERBOSE_1, LOG_ALLVERBOSE_2
Has the same meaning as their LOG_0 counterparts but instead applies to all locations in the parallel context.

Author
Jan

Usage Examples:

test/framework/log/timingblock_test.lua
test/framework/chi_mesh/ReadWavefrontObj1.lua
test/framework/chi_mesh/LogicalVolume/lv_sphere_test1.lua
test/framework/chi_mesh/LogicalVolume/lv_rpp_test1.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_2a_DirBCs.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_3a_analytical_coef.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_3b_analytical_coef2.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_2b_RobinBCs.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_3c_L2_error_MMS.lua
test/modules/DFEM_Diffusion/dDiffusion_2D_1a_linear.lua
test/modules/Diffusion/Diffusion1D_IP.lua
test/modules/Diffusion/Diffusion1D.lua
test/modules/Diffusion/Diffusion3D_1Poly_IP.lua
test/modules/Diffusion/Diffusion3D_2Ortho.lua
test/modules/Diffusion/Diffusion3D_3Unstructured_IP.lua
test/modules/Diffusion/Diffusion3D_1Poly.lua
test/modules/Diffusion/Diffusion2D_1Poly.lua
test/modules/Diffusion/Diffusion2D_1Poly_IP.lua
test/modules/Diffusion/Diffusion3D_4VTU.lua
test/modules/Diffusion/Diffusion2D_2Unstructured.lua
test/modules/Diffusion/Diffusion1D_KBA.lua
test/modules/Diffusion/Diffusion2D_2Unstructured_IP.lua
test/modules/Diffusion/Diffusion3D_3Unstructured.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady_Cyl/Transport2DCyl_1Monoenergetic.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady_Cyl/Transport2DCyl_2Multigroup.lua
test/modules/LinearBoltzmannSolvers/MGDiffusion_KEigen/KEigenvalueMIP1D_1G.lua
test/modules/LinearBoltzmannSolvers/Transport_SteadyCBC/Transport2D_1Poly.lua
test/modules/LinearBoltzmannSolvers/Transport_SteadyCBC/Transport1D_1.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_3c_response.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_1a_forward.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_2a_forward.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_2b_adjoint.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_1b_adjoint.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_2c_response.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_3a_forward.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_3b_adjoint.lua
test/modules/LinearBoltzmannSolvers/Transport_Adjoint/Adjoint2D_1c_response.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport1D_1.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport1D_3.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport2D_3.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport2D_2.lua
test/modules/LinearBoltzmannSolvers/Transport_Transient/TransientTransport1D_2.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_3Poly_quad_mod.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_5PolyA_AniHeteroBndry.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_1Poly_Balance.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_5Cycles2.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_4b_DSA_ortho.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_1Poly_BalanceMG.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_1Poly.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1a_Extruder.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_4a_DSA_ortho.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_6ASplitMesh.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_3a_DSA_ortho.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1Poly_qmom_part1.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_2Unstructured.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_6BSplitMesh.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport1D_1.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport1D_3a_DSA_ortho.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1Poly_qmom_part2.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport1D_4_DSA_ortho_inf.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_4Cycles1.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1b_Ortho.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport2D_2Unstructured.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_1Poly_parmetis.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport1D_1G_CBC.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/KEigenvalueTransport1D_1G.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/c5g7/c5g7.lua
test/modules/LinearBoltzmannSolvers/Transport_Keigen/c5g7/materials/materials.lua
test/modules/LinearBoltzmannSolvers/MGDiffusion_Steady/MIPDiffusion3D_3a_DSA_ortho.lua
test/modules/LinearBoltzmannSolvers/MGDiffusion_Steady/MIPDiffusion3D_1b_Ortho.lua

Definition at line 2455 of file lua_functions.c.

◆ chiLogPrintTimingGraph()

void chi_lua::chiLogPrintTimingGraph ( int  rank)

Prints the performance graph. \params rank int Optional argument to print the graph for a specific rank.

Usage Examples:

test/framework/log/timingblock_test.lua
test/modules/LinearBoltzmannSolvers/Transport_Steady/Transport3D_6ASplitMesh.lua

Definition at line 2475 of file lua_functions.c.

◆ chiLogProcessEvent()

double chi_lua::chiLogProcessEvent ( string  event_name,
string  event_operation_name 
)

Processes the sub-events of a repeating event and converts it to a meaningful value (floating-point).

Parameters
event_namestring Required. Name of the event.
event_operation_namestring Required. What kind of operation to be applied. See chi::ChiLog::EventOperation
Returns
double The processed value.

Definition at line 2466 of file lua_functions.c.

◆ chiLogSetVerbosity()

void chi_lua::chiLogSetVerbosity ( int  int_level)

Sets the verbosity level of the Logger. This lua command will overwrite the currently set value.

Parameters
int_levelint Integer denoting verbosity level. Can be 0,1 or 2 [default:0]
Author
Jan

Definition at line 2347 of file lua_functions.c.