/usr/include/code_saturne/fvm_writer.h is in code-saturne-include 3.3.2-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 | #ifndef __FVM_WRITER_H__
#define __FVM_WRITER_H__
/*============================================================================
* Handle export of mesh and fields.
*============================================================================*/
/*
This file is part of Code_Saturne, a general-purpose CFD tool.
Copyright (C) 1998-2014 EDF S.A.
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/*----------------------------------------------------------------------------*/
#include "cs_defs.h"
/*----------------------------------------------------------------------------
* Local headers
*----------------------------------------------------------------------------*/
#include "cs_timer.h"
#include "fvm_defs.h"
#include "fvm_nodal.h"
/*----------------------------------------------------------------------------*/
BEGIN_C_DECLS
/*=============================================================================
* Macro definitions
*============================================================================*/
/*============================================================================
* Type definitions
*============================================================================*/
/*----------------------------------------------------------------------------
* Element types
*----------------------------------------------------------------------------*/
typedef enum {
FVM_WRITER_FIXED_MESH, /* Mesh definitions do not change with time */
FVM_WRITER_TRANSIENT_COORDS, /* Vertex coordinates may change with time */
FVM_WRITER_TRANSIENT_CONNECT /* Mesh connectivity may change with time */
} fvm_writer_time_dep_t;
/*----------------------------------------------------------------------------
* Variable definition type
*----------------------------------------------------------------------------*/
typedef enum {
FVM_WRITER_PER_NODE, /* Variable values per node */
FVM_WRITER_PER_ELEMENT, /* Variable values per element */
FVM_WRITER_PER_PARTICLE /* Variable values per particle */
} fvm_writer_var_loc_t;
/*----------------------------------------------------------------------------
* Opaque structure defining a writer definition
*----------------------------------------------------------------------------*/
typedef struct _fvm_writer_t fvm_writer_t;
/*=============================================================================
* Static global variables
*============================================================================*/
/* Names of time dependency enumeration values */
extern const char *fvm_writer_time_dep_name[];
/*=============================================================================
* Public function prototypes
*============================================================================*/
/*----------------------------------------------------------------------------
* Find the format matching a name,
*
* parameters:
* format_name <-- name of desired format
*
* returns:
* index of the format matching the given name, or -1 if none matches.
*----------------------------------------------------------------------------*/
int
fvm_writer_get_format_id(const char *format_name);
/*----------------------------------------------------------------------------
* Returns number of known formats.
*----------------------------------------------------------------------------*/
int
fvm_writer_n_formats(void);
/*----------------------------------------------------------------------------
* Returns name of a known format.
*
* parameters:
* format_index <-- index of format in known format list (0 to n-1)
*
* returns:
* pointer to constant string containing the format's name
*----------------------------------------------------------------------------*/
const char *
fvm_writer_format_name(int format_index);
/*----------------------------------------------------------------------------
* Returns availability of a known format.
*
* parameters:
* format_index <-- index of format in known format list (0 to n-1)
*
* returns:
* 1 if the format is available, 0 otherwise.
*----------------------------------------------------------------------------*/
int
fvm_writer_format_available(int format_index);
/*----------------------------------------------------------------------------
* Returns number of library version strings associated with a given format.
*
* For writers requiring an external library, the first associated
* version string should correspond to that library, with possible
* additional version strings for its dependencies.
*
* For writers only requiring standard libraries (libc, MPI, MPI-IO),
* this function should return 0.
*
* parameters:
* format_index <-- index of format in known format list (0 to n-1)
*
* returns:
* number of library version strings associated with a given format.
*----------------------------------------------------------------------------*/
int
fvm_writer_n_version_strings(int format_index);
/*----------------------------------------------------------------------------
* Returns a library version string associated with a given format.
*
* We must have string_index < fvm_writer_n_version_strings(format_index).
*
* In certain cases, when using dynamic libraries, fvm may be compiled
* with one library version, and linked with another. If both run-time
* and compile-time version information is available, this function
* will return the run-time version string by default.
*
* Setting the compile_time flag to 1, the compile-time version string
* will be returned if this is different from the run-time version.
* If the version is the same, or only one of the 2 version strings are
* available, a NULL character string will be returned with this flag set.
*
* parameters:
* format_index <-- index of format in known format list (0 to n-1)
* string_index <-- index in format's version string list (0 to n-1)
* compile_time <-- 0 by default, 1 if we want the compile-time version
* string, if different from the run-time version.
*
* returns:
* pointer to constant string containing the library's version.
*----------------------------------------------------------------------------*/
const char *
fvm_writer_version_string(int format_index,
int string_index,
int compile_time_version);
/*----------------------------------------------------------------------------
* Initialize FVM mesh and field output writer.
*
* Allowed options depend on what is applicable to a given format. Those
* not relevant to a given writer are ignored. Possible options include:
* text output text files (EnSight)
* binary output binary files (EnSight, default)
* big_endian force binary files to big-endian (EnSight)
* adf use ADF file type (CGNS)
* hdf5 use HDF5 file type (CGNS, default if available)
* discard_polygons do not output polygons or related values
* discard_polyhedra do not output polyhedra or related values
* divide_polygons tesselate polygons with triangles
* divide_polyhedra tesselate polyhedra with tetrahedra and pyramids
* (adding a vertex near each polyhedron's center)
* split_tensors write tensor values as separate scalars
*
* parameters:
* name <-- base name of output
* path <-- optional directory name for output
* (directory automatically created if necessary)
* format_name <-- name of selected format (case-independent)
* format_options <-- options for the selected format (case-independent,
* whitespace or comma separated list)
* time_dependency <-- indicates if and how meshes will change with time
*
* returns:
* pointer to mesh and field output writer
*----------------------------------------------------------------------------*/
fvm_writer_t *
fvm_writer_init(const char *name,
const char *path,
const char *format_name,
const char *format_options,
fvm_writer_time_dep_t time_dependency);
/*----------------------------------------------------------------------------
* Finalize FVM mesh and field output writer.
*
* parameters:
* this_writer <-- pointer to mesh and field output writer
*
* returns:
* NULL pointer
*----------------------------------------------------------------------------*/
fvm_writer_t *
fvm_writer_finalize(fvm_writer_t *this_writer);
/*----------------------------------------------------------------------------
* Return a writer's name.
*
* parameters:
* this_writer <-- pointer to mesh and field output writer
*
* returns:
* pointer to base name of output associated with the writer
*----------------------------------------------------------------------------*/
const char *
fvm_writer_get_name(const fvm_writer_t *this_writer);
/*----------------------------------------------------------------------------
* Return a writer's associated format name.
*
* parameters:
* this_writer <-- pointer to mesh and field output writer
*
* returns:
* pointer to output format name associated with the writer
*----------------------------------------------------------------------------*/
const char *
fvm_writer_get_format(const fvm_writer_t *this_writer);
/*----------------------------------------------------------------------------
* Return a writer's associated format options.
*
* parameters:
* this_writer <-- pointer to mesh and field output writer
*
* returns:
* pointer to output format options associated with the writer
*----------------------------------------------------------------------------*/
const char *
fvm_writer_get_options(const fvm_writer_t *this_writer);
/*----------------------------------------------------------------------------
* Return a writer's associated output directory.
*
* parameters:
* this_writer <-- pointer to mesh and field output writer
*
* returns:
* pointer to output format options associated with the writer
*----------------------------------------------------------------------------*/
const char *
fvm_writer_get_path(const fvm_writer_t *this_writer);
/*----------------------------------------------------------------------------
* Return geometry time dependency status of a writer.
*
* parameters:
* this_writer <-- pointer to mesh and field output writer
*
* returns:
* time dependency status
*----------------------------------------------------------------------------*/
fvm_writer_time_dep_t
fvm_writer_get_time_dep(const fvm_writer_t *this_writer);
/*----------------------------------------------------------------------------
* Associate new time step with a mesh.
*
* parameters:
* this_writer_p <-- pointer to associated writer
* time_step <-- time step number
* time_value <-- time_value number
*----------------------------------------------------------------------------*/
void
fvm_writer_set_mesh_time(fvm_writer_t *this_writer,
int time_step,
double time_value);
/*----------------------------------------------------------------------------
* Query if elements of a given type will need to be tesselated
* for use of a nodal mesh with an output writer.
*
* This function should be called before any fvm_writer_export_...()
*
* parameters:
* this_writer <-- pointer to mesh and field output writer
* mesh <-- pointer to nodal mesh
* element_type <-- type of element
*
* returns:
* 0 if no tesselation is necessary, 1 if tesselation is necessary.
*----------------------------------------------------------------------------*/
int
fvm_writer_needs_tesselation(fvm_writer_t *this_writer,
const fvm_nodal_t *mesh,
fvm_element_t element_type);
/*----------------------------------------------------------------------------
* Export FVM nodal mesh.
*
* parameters:
* this_writer <-- pointer to mesh and field output writer
* mesh <-- pointer to nodal mesh
*----------------------------------------------------------------------------*/
void
fvm_writer_export_nodal(fvm_writer_t *this_writer,
const fvm_nodal_t *mesh);
/*----------------------------------------------------------------------------
* Export field associated with a nodal mesh.
*
* Assigning a negative value to the time step indicates a time-independent
* field (in which case the time_value argument is unused).
*
* parameters:
* this_writer <-- pointer to mesh and field output writer
* mesh <-- pointer to associated nodal mesh structure
* name <-- variable name
* location <-- variable definition location (nodes or elements)
* dimension <-- variable dimension (0: constant, 1: scalar,
* 3: vector, 6: sym. tensor, 9: asym. tensor)
* interlace <-- indicates if variable in memory is interlaced
* n_parent_lists <-- indicates if variable values are to be obtained
* directly through the local entity index (when 0) or
* through the parent entity numbers (when 1 or more)
* parent_num_shift <-- parent number to value array index shifts;
* size: n_parent_lists
* datatype <-- indicates the data type of (source) field values
* time_step <-- number of the current time step
* time_value <-- associated time value
* field_values <-- array of associated field value arrays
*----------------------------------------------------------------------------*/
void
fvm_writer_export_field(fvm_writer_t *this_writer,
const fvm_nodal_t *mesh,
const char *name,
fvm_writer_var_loc_t location,
int dimension,
cs_interlace_t interlace,
int n_parent_lists,
const cs_lnum_t parent_num_shift[],
cs_datatype_t datatype,
int time_step,
double time_value,
const void *const field_values[]);
/*----------------------------------------------------------------------------
* Flush files associated with a given writer.
*
* parameters:
* this_writer <-- pointer to mesh and field output writer
*----------------------------------------------------------------------------*/
void
fvm_writer_flush(fvm_writer_t *this_writer);
/*----------------------------------------------------------------------------
* Return accumulated times associated with output for a given writer.
*
* parameters:
* this_writer <-- pointer to mesh and field output writer
* mesh_time --> Meshes output time (or NULL)
* field_time --> Fields output time (or NULL)
* flush_time --> remaining (applying output) time (or NULL)
*----------------------------------------------------------------------------*/
void
fvm_writer_get_times(fvm_writer_t *this_writer,
cs_timer_counter_t *mesh_time,
cs_timer_counter_t *field_time,
cs_timer_counter_t *flush_time);
/*----------------------------------------------------------------------------*/
END_C_DECLS
#endif /* __FVM_WRITER_H__ */
|