Caelus Python API¶
- caelus.config – Caelus Configuration Infrastructure
- Caelus Python Configuration
CaelusCfgconfigure_logging()get_appdata_dir()get_caelus_root()get_config()get_cpl_root()get_default_config()rcfiles_loaded()reload_config()reset_default_config()search_cfg_files()- Caelus CML Environment Manager
CMLEnvFOAMEnvFOAMEnv.etc_file()FOAMEnv.from_modules()FOAMEnv.bin_dirFOAMEnv.build_dirFOAMEnv.build_optionFOAMEnv.environFOAMEnv.etc_dirsFOAMEnv.foam_api_infoFOAMEnv.foam_bashrcFOAMEnv.foam_versionFOAMEnv.lib_dirFOAMEnv.module_listFOAMEnv.mpi_bindirFOAMEnv.mpi_dirFOAMEnv.mpi_libdirFOAMEnv.project_dirFOAMEnv.rootFOAMEnv.site_dirFOAMEnv.site_libdirFOAMEnv.user_bindirFOAMEnv.user_dirFOAMEnv.user_libdirFOAMEnv.version
HelyxEnvHelyxEnv.etc_file()HelyxEnv.bin_dirHelyxEnv.build_dirHelyxEnv.build_optionHelyxEnv.environHelyxEnv.etc_dirsHelyxEnv.foam_bashrcHelyxEnv.lib_dirHelyxEnv.module_listHelyxEnv.mpi_bindirHelyxEnv.mpi_dirHelyxEnv.mpi_libdirHelyxEnv.project_dirHelyxEnv.site_dirHelyxEnv.site_libdirHelyxEnv.user_bindirHelyxEnv.user_dirHelyxEnv.user_libdirHelyxEnv.version
cml_get_latest_version()cml_get_version()discover_versions()get_cmlenv_instance()is_foam_var()
- caelus.utils – Basic utilities
- caelus.run – CML Execution Utilities
- Caelus Tasks Manager
TasksTasksMeta- CML Simulation
CMLSimBaseCMLSimBase.clean()CMLSimBase.clone()CMLSimBase.get_input_dict()CMLSimBase.load()CMLSimBase.save_state()CMLSimBase.LESPropertiesCMLSimBase.RASPropertiesCMLSimBase.basedirCMLSimBase.blockMeshDictCMLSimBase.casedirCMLSimBase.changeDictionaryDictCMLSimBase.cmlControlsCMLSimBase.controlDictCMLSimBase.decomposeParDictCMLSimBase.envCMLSimBase.fvSchemesCMLSimBase.fvSolutionCMLSimBase.nameCMLSimBase.parentCMLSimBase.run_configCMLSimBase.run_flagsCMLSimBase.transportPropertiesCMLSimBase.turbulencePropertiesCMLSimBase.udf
CMLSimCollectionCMLSimCollection.filter_cases()CMLSimCollection.load()CMLSimCollection.post()CMLSimCollection.prep()CMLSimCollection.save_state()CMLSimCollection.setup()CMLSimCollection.simulation_class()CMLSimCollection.solve()CMLSimCollection.status()CMLSimCollection.udf_instance()CMLSimCollection.basedirCMLSimCollection.case_namesCMLSimCollection.casedirCMLSimCollection.casesCMLSimCollection.envCMLSimCollection.nameCMLSimCollection.udfCMLSimCollection.udf_paramsCMLSimCollection.udf_script
CMLSimMetaCMLSimulationCMLSimulation.case_log()CMLSimulation.decompose_case()CMLSimulation.post_case()CMLSimulation.prep_case()CMLSimulation.reconstruct_case()CMLSimulation.run_tasks()CMLSimulation.solve()CMLSimulation.status()CMLSimulation.update()CMLSimulation.LESPropertiesCMLSimulation.RASPropertiesCMLSimulation.blockMeshDictCMLSimulation.changeDictionaryDictCMLSimulation.cmlControlsCMLSimulation.controlDictCMLSimulation.decomposeParDictCMLSimulation.fvSchemesCMLSimulation.fvSolutionCMLSimulation.job_idsCMLSimulation.logfileCMLSimulation.run_flagsCMLSimulation.solverCMLSimulation.task_fileCMLSimulation.transportPropertiesCMLSimulation.turbulenceProperties
- CML Parametric Run Manager
CMLParametricRuniter_case_params()normalize_variable_param()- Caelus Job Manager Interface
CaelusCmd- CML Execution Utilities
clean_casedir()clean_polymesh()clone_case()find_caelus_recipe_dirs()find_case_dirs()find_recipe_dirs()get_mpi_size()is_caelus_casedir()- Job Scheduler Interface
HPCQueueHPCQueue.nameHPCQueue.queueHPCQueue.accountHPCQueue.num_nodesHPCQueue.num_ranksHPCQueue.stdoutHPCQueue.stderrHPCQueue.join_outputsHPCQueue.mail_optsHPCQueue.email_addressHPCQueue.qosHPCQueue.time_limitHPCQueue.shellHPCQueue.mpi_extra_argsHPCQueue.delete()HPCQueue.get_queue_settings()HPCQueue.is_job_scheduler()HPCQueue.is_parallel()HPCQueue.prepare_mpi_cmd()HPCQueue.process_cml_run_env()HPCQueue.process_foam_run_env()HPCQueue.process_run_env()HPCQueue.submit()HPCQueue.update()HPCQueue.write_script()HPCQueue.queue_nameHPCQueue.script_body
PBSQueueParallelJobSerialJobSlurmQueuecaelus_execute()get_job_scheduler()python_execute()
- caelus.post – Post-processing utilities
- Post-processing interface
PostProcessing- Core function object utilities
DictMetaFuncObjMetaFunctionObjectFunctionObject.create()FunctionObject.funcobj_type()FunctionObject.enabledFunctionObject.executeControlFunctionObject.executeIntervalFunctionObject.latest_timeFunctionObject.libsFunctionObject.logFunctionObject.regionFunctionObject.rootFunctionObject.timeEndFunctionObject.timeStartFunctionObject.timesFunctionObject.writeControlFunctionObject.writeInterval
- Sets and surfaces sampling
SampledDataSampledSetSampledSetsSampledSurfaceSampledSurfacesSampling- Force and Force coefficients interface
ForceCoeffsForcesLiftDragLiftDrag.UinfLiftDrag.dragDirectionLiftDrag.liftDirectionLiftDrag.maxCpLiftDrag.minCpLiftDrag.nAveragingStepsLiftDrag.outputRegionDataLiftDrag.patchesLiftDrag.pitchAxisLiftDrag.porosityLiftDrag.referenceAreaLiftDrag.referenceLengthLiftDrag.rhoInfoLiftDrag.runOnLastIterOnlyLiftDrag.wheelbaseLiftDrag.writeFields
- Caelus Log Analyzer
LogProcessorLogProcessor.add_rule()LogProcessor.bounding_processor()LogProcessor.completion_processor()LogProcessor.continuity_processor()LogProcessor.convergence_processor()LogProcessor.courant_processor()LogProcessor.exec_time_processor()LogProcessor.exiting_processor()LogProcessor.extend_rule()LogProcessor.fatal_error_processor()LogProcessor.residual_processor()LogProcessor.time_processor()LogProcessor.watch_file()LogProcessor.bound_filesLogProcessor.case_dirLogProcessor.convergedLogProcessor.converged_timeLogProcessor.current_stateLogProcessor.failedLogProcessor.logfileLogProcessor.logs_dirLogProcessor.res_filesLogProcessor.solve_completedLogProcessor.subiter_mapLogProcessor.timeLogProcessor.time_str
SolverLog- Caelus Plotting Utilities
CaelusPlotLogWatcherPlotsMetamake_plot_method()mpl_settings()
- caelus.io – CML Input File Manipulation
- Caelus/OpenFOAM Input File Interface
BlockMeshDictChangeDictionaryDictCmlControlsControlDictControlDict.create_default_entries()ControlDict.adjustTimeStepControlDict.applicationControlDict.deltaTControlDict.endTimeControlDict.functionsControlDict.graphFormatControlDict.maxCoControlDict.purgeWriteControlDict.runTimeModifiableControlDict.startFromControlDict.startTimeControlDict.stopAtControlDict.timeFormatControlDict.timePrecisionControlDict.writeCompressionControlDict.writeControlControlDict.writeFormatControlDict.writeIntervalControlDict.writePrecision
DecomposeParDictDictFileDictMetaFvSchemesFvSolutionLESPropertiesPolyMeshBoundaryRASPropertiesTransportPropertiesTurbModelPropsTurbulencePropertiescml_std_files- Caelus/OpenFOAM Dictionary Implementation
CaelusDictBoundaryListCalcDirectiveCodeStreamDimStrDimValueDimensionDirectiveEvalDirectiveFieldFoamTypeListTemplateMacroSubstitutionMultipleValues- Caelus Input File Pretty-printer
DictPrinterIndenterfoam_writer()
- caelus.scripts – CLI App Utilities