From 4a3ad242cdd3d1bbc0bebae68818da88121c8cb1 Mon Sep 17 00:00:00 2001 From: Alexandre Barbosa Bruno Date: Mon, 27 Jan 2025 11:05:12 -0300 Subject: [PATCH] Informing that can get tracers already defined in Alfasim (#419) * add documentation * add example --- src/alfasim_sdk/alfasim_sdk_api/api.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/alfasim_sdk/alfasim_sdk_api/api.h b/src/alfasim_sdk/alfasim_sdk_api/api.h index 4b99fb11..55b35172 100644 --- a/src/alfasim_sdk/alfasim_sdk_api/api.h +++ b/src/alfasim_sdk/alfasim_sdk_api/api.h @@ -693,7 +693,13 @@ DLL_EXPORT int get_tracer_name(void* ctx, char* out, void* reference, int size); /*! Gets the tracer reference for a given tracer name. This function is important to obtain the - tracer reference of a user defined tracer added by the plugin. + tracer reference of a user defined tracer added by the plugin or tracers already defined by ALFAsim. + PVT Combined Models will create tracers with their names equals to the fluids names inside the model. + + Example of usage: + ~~~~~{.cpp} + errcode = get_tracer_ref_by_name(ctx, &tracer_ref, "Combined Fluid 1", plugin_id); + ~~~~~ @param[in] ctx ALFAsim's plugins context. @param[out] reference Tracer reference.