programmer's documentation
fvm_writer_priv.h
Go to the documentation of this file.
1 #ifndef __FVM_WRITER_PRIV_H__
2 #define __FVM_WRITER_PRIV_H__
3 
4 /*============================================================================
5  * Private types for mesh and field writers
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2016 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 #include "cs_defs.h"
31 
32 /*----------------------------------------------------------------------------
33  * Local headers
34  *----------------------------------------------------------------------------*/
35 
36 #include "cs_timer.h"
37 
38 #include "fvm_defs.h"
39 #include "fvm_nodal.h"
40 #include "fvm_writer.h"
41 
42 /*----------------------------------------------------------------------------*/
43 
45 
46 /*=============================================================================
47  * Macro definitions
48  *============================================================================*/
49 
50 /*
51  * Writer format implementation and functionality info
52  */
53 
54 #define FVM_WRITER_FORMAT_USE_EXTERNAL (1 << 0)
55 
56 #define FVM_WRITER_FORMAT_HAS_POLYGON (1 << 1)
57 #define FVM_WRITER_FORMAT_HAS_POLYHEDRON (1 << 2)
58 
59 #define FVM_WRITER_FORMAT_SEPARATE_MESHES (1 << 3)
60 
61 /*============================================================================
62  * Type definitions
63  *============================================================================*/
64 
65 /*----------------------------------------------------------------------------
66  * Function pointer types
67  *----------------------------------------------------------------------------*/
68 
69 typedef int
71 
72 typedef const char *
73 (fvm_writer_version_string_t)(int string_index,
74  int compile_time_version);
75 
76 #if defined(HAVE_MPI)
77 
78 typedef void *
79 (fvm_writer_init_t) (const char *name,
80  const char *path,
81  const char *options,
82  fvm_writer_time_dep_t time_dependency,
83  MPI_Comm comm);
84 
85 #else
86 
87 typedef void *
88 (fvm_writer_init_t) (const char *name,
89  const char *path,
90  const char *options,
91  fvm_writer_time_dep_t time_dependency);
92 
93 #endif /* defined(HAVE_MPI) */
94 
95 typedef void *
96 (fvm_writer_finalize_t) (void *this_writer);
97 
98 typedef void
99 (fvm_writer_set_mesh_time_t) (void *this_writer,
100  int time_step,
101  double time_value);
102 
103 typedef int
104 (fvm_writer_needs_tesselation_t) (void *this_writer,
105  const fvm_nodal_t *mesh,
106  fvm_element_t element_type);
107 
108 typedef void
109 (fvm_writer_export_nodal_t) (void *this_writer,
110  const fvm_nodal_t *mesh);
111 
112 typedef void
113 (fvm_writer_export_field_t) (void *this_writer,
114  const fvm_nodal_t *mesh,
115  const char *name,
116  fvm_writer_var_loc_t location,
117  int dimension,
118  cs_interlace_t interlace,
119  int n_parent_lists,
120  const cs_lnum_t parent_num_shift[],
121  cs_datatype_t datatype,
122  int time_step,
123  double time_value,
124  const void *const field_values[]);
125 
126 typedef void
127 (fvm_writer_flush_t) (void *this_writer);
128 
129 /*----------------------------------------------------------------------------
130  * Format information structure
131  *----------------------------------------------------------------------------*/
132 
133 typedef struct {
134 
135  char name[32]; /* Format name */
136  char version[16]; /* Format version (if defined) */
137  int info_mask; /* Additional format info */
138  fvm_writer_time_dep_t max_time_dep; /* Maximum time dependency level
139  possible with this format */
140 
141  int dl_count; /* Number of writers using the
142  dynamically loadable library
143  for this format, if relevant */
144  void *dl_lib; /* Pointer to dynamically loadable
145  library, if used */
146  const char *dl_name; /* Prefix for name of dynamically
147  loadable library, or NULL */
148  const char *dl_prefix; /* Prefix for exported symbols of
149  dynamically loadable library,
150  or NULL */
151 
161 
163 
164 /*----------------------------------------------------------------------------
165  * Structure defining a writer definition
166  *----------------------------------------------------------------------------*/
167 
169 
170  char *name; /* Writer name */
171  fvm_writer_format_t *format; /* Output format */
172  char *options; /* Output options */
173  char *path; /* Output path */
174  fvm_writer_time_dep_t time_dep; /* Geometry time dependency */
175  int n_format_writers; /* number of actual writers */
176  void **format_writer; /* Format-specific writers */
177  char **mesh_names; /* List of mesh names if one
178  writer per mesh is required */
179 
180  cs_timer_counter_t mesh_time; /* Meshes output timer */
181  cs_timer_counter_t field_time; /* Fields output timer */
182  cs_timer_counter_t flush_time; /* output "completion" timer */
183 
184 };
185 
186 /*----------------------------------------------------------------------------*/
187 
189 
190 #endif /* __FVM_WRITER_PRIV_H__ */
cs_datatype_t
Definition: cs_defs.h:255
fvm_writer_needs_tesselation_t * needs_tesselation_func
Definition: fvm_writer_priv.h:157
fvm_writer_set_mesh_time_t * set_mesh_time_func
Definition: fvm_writer_priv.h:156
fvm_writer_finalize_t * finalize_func
Definition: fvm_writer_priv.h:155
fvm_writer_var_loc_t
Definition: fvm_writer.h:69
int dl_count
Definition: fvm_writer_priv.h:141
cs_interlace_t
Definition: cs_defs.h:421
Definition: fvm_writer_priv.h:133
Definition: fvm_writer_priv.h:168
#define BEGIN_C_DECLS
Definition: cs_defs.h:448
cs_timer_counter_t flush_time
Definition: fvm_writer_priv.h:182
void( fvm_writer_flush_t)(void *this_writer)
Definition: fvm_writer_priv.h:127
int( fvm_writer_needs_tesselation_t)(void *this_writer, const fvm_nodal_t *mesh, fvm_element_t element_type)
Definition: fvm_writer_priv.h:104
void *( fvm_writer_init_t)(const char *name, const char *path, const char *options, fvm_writer_time_dep_t time_dependency)
Definition: fvm_writer_priv.h:88
fvm_writer_version_string_t * version_string_func
Definition: fvm_writer_priv.h:153
const char * dl_name
Definition: fvm_writer_priv.h:146
fvm_writer_time_dep_t
Definition: fvm_writer.h:57
fvm_writer_time_dep_t max_time_dep
Definition: fvm_writer_priv.h:138
const char *( fvm_writer_version_string_t)(int string_index, int compile_time_version)
Definition: fvm_writer_priv.h:73
int( fvm_writer_n_version_strings_t)(void)
Definition: fvm_writer_priv.h:70
fvm_writer_export_field_t * export_field_func
Definition: fvm_writer_priv.h:159
char * options
Definition: fvm_writer_priv.h:172
int n_format_writers
Definition: fvm_writer_priv.h:175
fvm_element_t
Definition: fvm_defs.h:48
int info_mask
Definition: fvm_writer_priv.h:137
fvm_writer_time_dep_t time_dep
Definition: fvm_writer_priv.h:174
void( fvm_writer_set_mesh_time_t)(void *this_writer, int time_step, double time_value)
Definition: fvm_writer_priv.h:99
const char * dl_prefix
Definition: fvm_writer_priv.h:148
void ** format_writer
Definition: fvm_writer_priv.h:176
fvm_writer_export_nodal_t * export_nodal_func
Definition: fvm_writer_priv.h:158
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:292
void *( fvm_writer_finalize_t)(void *this_writer)
Definition: fvm_writer_priv.h:96
fvm_writer_format_t * format
Definition: fvm_writer_priv.h:171
fvm_writer_flush_t * flush_func
Definition: fvm_writer_priv.h:160
#define END_C_DECLS
Definition: cs_defs.h:449
char ** mesh_names
Definition: fvm_writer_priv.h:177
fvm_writer_init_t * init_func
Definition: fvm_writer_priv.h:154
char * name
Definition: fvm_writer_priv.h:170
cs_timer_counter_t mesh_time
Definition: fvm_writer_priv.h:180
char * path
Definition: fvm_writer_priv.h:173
void * dl_lib
Definition: fvm_writer_priv.h:144
fvm_writer_n_version_strings_t * n_version_strings_func
Definition: fvm_writer_priv.h:152
cs_timer_counter_t field_time
Definition: fvm_writer_priv.h:181
Definition: mesh.f90:26
void( fvm_writer_export_field_t)(void *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[])
Definition: fvm_writer_priv.h:113
void( fvm_writer_export_nodal_t)(void *this_writer, const fvm_nodal_t *mesh)
Definition: fvm_writer_priv.h:109
Definition: cs_timer.h:57