File: cs_lagr_post.h

package info (click to toggle)
code-saturne 4.3.3%2Brepack-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 77,992 kB
  • sloc: ansic: 281,257; f90: 122,305; python: 56,490; makefile: 3,915; xml: 3,285; cpp: 3,183; sh: 1,139; lex: 176; yacc: 101; sed: 16
file content (147 lines) | stat: -rw-r--r-- 5,181 bytes parent folder | download
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
#ifndef __CS_LAGR_POST_H__
#define __CS_LAGR_POST_H__

/*============================================================================
 * Lagrangian module postprocessing
 *============================================================================*/

/*
  This file is part of Code_Saturne, a general-purpose CFD tool.

  Copyright (C) 1998-2016 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"

#include "assert.h"
#include "cs_base.h"
#include "cs_field.h"

#include "cs_lagr.h"

/*----------------------------------------------------------------------------*/

BEGIN_C_DECLS

/*=============================================================================
 * Macro definitions
 *============================================================================*/

/*============================================================================
 * Type definitions
 *============================================================================*/

typedef struct {

  /*! \anchor iensi3
    activation (=1) or not (=0) of the recording of the particle/boundary
    interactions in  \ref bound_stat, and of the calculation of the
    statistics at the corresponding boundaries.
    By default, the statistics are unsteady (reset to zero at every
    time step). They may be steady if \ref isttio=1 (i.e.
    calculation of a cumulated value over time, and then calculation of an
    average over time or over the number of interactions with the boundary).*/
  int  iensi3;

  /*! associates (=1) or not (=0) the variable "velocity of the locally
    undisturbed fluid flow field" with the output of particles or
    trajectories. */
  int  ivisv1;

  /*! associates (=1) or not (=0) the variable "particle velocity"
    with the output of particles or trajectories. */
  int  ivisv2;

  /*! associates (=1) or not (=0) the variable "residence time"
    with the output of particles or trajectories. */
  int  ivistp;

  /*! associates (=1) or not (=0) the variable "particle diameter"
    with the output of particles or trajectories. */
  int  ivisdm;

  /*! associates (=1) or not (=0) the variable "particle temperature"
     with the output of particles or trajectories. */
  int  iviste;

  /*! associates (=1) or not (=0) the variable "particle mass"
    with the output of particles or trajectories. */
  int  ivismp;

  /*! associates (=1) or not (=0) the variable "shrinking core diameter of
    the coal particles" with the output of particles or trajectories.
    useful only if \ref iphyla = 2 */
  int  ivisdk;

  /*! associates (=1) or not (=0) the variable "mass of reactive coal of the
    coal particles" with the output of particles or trajectories.
    useful only if \ref iphyla = 2 */
  int  ivisch;

  /*! associates (=1) or not (=0) the variable "mass of coal of the
    coal particles" with the output of particles or trajectories.
    useful only if \ref iphyla = 2 */
  int  ivisck;

  /*! associates (=1) or not (=0) the variable "mass of water of the
    coal particles" with the output of particles or trajectories.
    useful only if \ref iphyla = 2 */
  int  iviswat;

} cs_lagr_post_options_t;

/*============================================================================
  Global variables
  ============================================================================*/

/*! read-only pointer to Lagrangian postprocessing options */

extern const cs_lagr_post_options_t *cs_glob_lagr_post_options;

/*============================================================================
 * Public function prototypes
 *============================================================================*/

/*----------------------------------------------------------------------------*/
/*!
 * \brief Initialize Lagrangian postprocessing.
 */
/*----------------------------------------------------------------------------*/

void
cs_lagr_post_init(void);

/*----------------------------------------------------------------------------*/
/*!
 * \brief Return a pointer to the global cs_lagr_post_options_t structure.
 *
 * This pointer allows write access to the structure.
 *
 * \return pointer to cs_glob_lagr_post_options
 */
/*----------------------------------------------------------------------------*/

cs_lagr_post_options_t *
cs_lagr_post_get_options(void);

/*----------------------------------------------------------------------------*/

END_C_DECLS

#endif /* __CS_LAGR_POST_H__ */