8.3
general documentation
cs_time_table.h
Go to the documentation of this file.
1#ifndef __CS_TIME_TABLE_H__
2#define __CS_TIME_TABLE_H__
3
4/*============================================================================
5 * Tabulation handling for code_saturne
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2024 EDF S.A.
12
13 This program is free software; you can redistribute it and/or modify it under
14 the terms of the GNU General Public License as published by the Free Software
15 Foundation; either version 2 of the License, or (at your option) any later
16 version.
17
18 This program is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21 details.
22
23 You should have received a copy of the GNU General Public License along with
24 this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
25 Street, Fifth Floor, Boston, MA 02110-1301, USA.
26*/
27
28/*----------------------------------------------------------------------------*/
29
30/*----------------------------------------------------------------------------
31 * Local headers
32 *----------------------------------------------------------------------------*/
33
34#include "cs_defs.h"
35#include "cs_time_step.h"
36
37/*----------------------------------------------------------------------------*/
38
39BEGIN_C_DECLS
40
41/*============================================================================
42 * Type definitions
43 *============================================================================*/
44
45typedef struct _cs_time_table_t cs_time_table_t;
46
47/*=============================================================================
48 * Public function prototypes
49 *============================================================================*/
50
51/*----------------------------------------------------------------------------*/
59/*----------------------------------------------------------------------------*/
60
61cs_time_table_t *
62cs_time_table_by_name_try(const char *name);
63
64/*----------------------------------------------------------------------------*/
72/*----------------------------------------------------------------------------*/
73
74cs_time_table_t *
75cs_time_table_by_name(const char *name);
76
77/*----------------------------------------------------------------------------*/
84/*----------------------------------------------------------------------------*/
85
86void
87cs_time_table_set_offset(cs_time_table_t *table,
88 cs_real_t time_offset);
89
90/*----------------------------------------------------------------------------*/
99/*----------------------------------------------------------------------------*/
100
101void
102cs_time_table_set_headers(cs_time_table_t *table,
103 const int n_headers,
104 const char **headers);
105
106/*----------------------------------------------------------------------------*/
120/*----------------------------------------------------------------------------*/
121
122cs_time_table_t *
123cs_time_table_from_csv_file(const char *name,
124 const char *file_name,
125 const char *separator,
126 const int n_headers,
127 const int n_columns,
128 const int *col_idx,
129 const bool ignore_missing_tokens);
130
131/*----------------------------------------------------------------------------*/
142/*----------------------------------------------------------------------------*/
143
144cs_time_table_t *
145cs_time_table_from_csv_file_simple(const char *name,
146 const char *file_name,
147 const char *separator);
148
149/*----------------------------------------------------------------------------*/
161/*----------------------------------------------------------------------------*/
162
163cs_time_table_t *
164cs_time_table_from_csv_file_simple_headers(const char *name,
165 const char *file_name,
166 const char *separator,
167 const int n_headers);
168
169/*----------------------------------------------------------------------------*/
176/*----------------------------------------------------------------------------*/
177
178void
179cs_time_table_set_time_col_id(cs_time_table_t *table,
180 const int col_id);
181
182/*----------------------------------------------------------------------------*/
189/*----------------------------------------------------------------------------*/
190
191void
192cs_time_table_set_time_from_label(cs_time_table_t *table,
193 const char *time_label);
194
195/*----------------------------------------------------------------------------*/
202/*----------------------------------------------------------------------------*/
203
204void
205cs_time_table_reset_position(cs_time_table_t *table);
206
207/*----------------------------------------------------------------------------*/
216/*----------------------------------------------------------------------------*/
217
218void
219cs_time_table_update_position(cs_time_table_t *table,
220 cs_real_t time,
221 bool reset_time_value);
222
223/*----------------------------------------------------------------------------*/
234/*----------------------------------------------------------------------------*/
235
236cs_real_t
237cs_time_table_compute_time_value(const char *name,
238 cs_real_t t,
239 const int col,
240 bool overwrite_prev);
241
242/*----------------------------------------------------------------------------*/
253/*----------------------------------------------------------------------------*/
254
255cs_real_t
256cs_time_table_compute_time_value_by_label(const char *name,
257 cs_real_t t,
258 const char *label,
259 bool overwrite_prev);
260
261/*----------------------------------------------------------------------------*/
273/*----------------------------------------------------------------------------*/
274
275void
276cs_time_table_compute_n_time_values(const char *name,
277 cs_real_t t,
278 const int n_cols,
279 const int cols[],
280 bool overwrite_prev,
281 cs_real_t *retvals);
282
283/*----------------------------------------------------------------------------*/
295/*----------------------------------------------------------------------------*/
296
297void
298cs_time_table_compute_n_time_values_by_label(const char *name,
299 cs_real_t t,
300 const int n_cols,
301 const char *labels[],
302 bool overwrite_prev,
303 cs_real_t *retvals);
304
305/*----------------------------------------------------------------------------*/
315/*----------------------------------------------------------------------------*/
316
317static inline cs_real_t
318CS_TIME_TABLE(const char *name,
319 const char *label)
320{
321 return cs_time_table_compute_time_value_by_label(name,
322 cs_glob_time_step->t_cur,
323 label,
324 false);
325}
326/*----------------------------------------------------------------------------*/
330/*----------------------------------------------------------------------------*/
331
332void
333cs_time_table_destroy_all(void);
334
335/*----------------------------------------------------------------------------*/
336
337END_C_DECLS
338
339#endif /* __CS_TIME_TABLE_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
t
@ t
Definition: cs_field_pointer.h:94
cs_time_step.h
cs_glob_time_step
const cs_time_step_t * cs_glob_time_step
cs_time_table_set_time_col_id
void cs_time_table_set_time_col_id(cs_time_table_t *table, const int col_id)
Define the column id for time based on an index.
Definition: cs_time_table.cpp:520
cs_time_table_compute_n_time_values_by_label
void cs_time_table_compute_n_time_values_by_label(const char *name, cs_real_t t, const int n_cols, const char *labels[], bool overwrite_prev, cs_real_t *retvals)
Compute values for several columns of a time table for a given abscissa.
Definition: cs_time_table.cpp:731
cs_time_table_update_position
void cs_time_table_update_position(cs_time_table_t *table, cs_real_t time, bool reset_time_value)
Update time coefficients used for data interpolation.
Definition: cs_time_table.cpp:585
cs_time_table_destroy_all
void cs_time_table_destroy_all(void)
Free all data structures related to datasets.
Definition: cs_time_table.cpp:754
cs_time_table_set_headers
void cs_time_table_set_headers(cs_time_table_t *table, const int n_headers, const char **headers)
Set headers labels for a time table. Number of headers needs to be equal to the number of columns,...
Definition: cs_time_table.cpp:353
cs_time_table_from_csv_file_simple_headers
cs_time_table_t * cs_time_table_from_csv_file_simple_headers(const char *name, const char *file_name, const char *separator, const int n_headers)
Define a time table from a CSV file. We suppose that all columns are to be read and that missing toke...
Definition: cs_time_table.cpp:494
cs_time_table_from_csv_file
cs_time_table_t * cs_time_table_from_csv_file(const char *name, const char *file_name, const char *separator, const int n_headers, const int n_columns, const int *col_idx, const bool ignore_missing_tokens)
Define a time table from a CSV file.
Definition: cs_time_table.cpp:394
cs_time_table_by_name_try
cs_time_table_t * cs_time_table_by_name_try(const char *name)
Try to get time table based on name.
Definition: cs_time_table.cpp:293
cs_time_table_from_csv_file_simple
cs_time_table_t * cs_time_table_from_csv_file_simple(const char *name, const char *file_name, const char *separator)
Define a time table from a CSV file. We suppose that all columns are to be read, no headers line to s...
Definition: cs_time_table.cpp:464
cs_time_table_by_name
cs_time_table_t * cs_time_table_by_name(const char *name)
Get time table based on name.
Definition: cs_time_table.cpp:311
cs_time_table_set_time_from_label
void cs_time_table_set_time_from_label(cs_time_table_t *table, const char *time_label)
Define the column id for time based on a label.
Definition: cs_time_table.cpp:538
CS_TIME_TABLE
static cs_real_t CS_TIME_TABLE(const char *name, const char *label)
Compute value from time table based on label and current time. Positions are not updated for the tabl...
Definition: cs_time_table.h:318
cs_time_table_compute_time_value
cs_real_t cs_time_table_compute_time_value(const char *name, cs_real_t t, const int col, bool overwrite_prev)
Compute value using a given abscissa and a specific column.
Definition: cs_time_table.cpp:643
cs_time_table_compute_n_time_values
void cs_time_table_compute_n_time_values(const char *name, cs_real_t t, const int n_cols, const int cols[], bool overwrite_prev, cs_real_t *retvals)
Compute values for several columns of a time table for a given abscissa.
Definition: cs_time_table.cpp:701
cs_time_table_set_offset
void cs_time_table_set_offset(cs_time_table_t *table, cs_real_t time_offset)
Set time offset value for a time table.
Definition: cs_time_table.cpp:333
cs_time_table_reset_position
void cs_time_table_reset_position(cs_time_table_t *table)
Reset time table time value (force search from beginning of table).
Definition: cs_time_table.cpp:563
cs_time_table_compute_time_value_by_label
cs_real_t cs_time_table_compute_time_value_by_label(const char *name, cs_real_t t, const char *label, bool overwrite_prev)
Compute value using a given abscissa and a label.
Definition: cs_time_table.cpp:669
label
char * label
Definition: keywords.h:58
cs_time_step_t::t_cur
double t_cur
Definition: cs_time_step.h:80