9.2
general documentation
cs_paramedmem_remapper.h
Go to the documentation of this file.
1#ifndef CS_PARAMEDMEM_REMAPPER_HXX
2#define CS_PARAMEDMEM_REMAPPER_HXX
3
4/*============================================================================
5 * Parallel interpolation using ParaMEDMEM OverlapDEC
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2026 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 * Local headers
30 *----------------------------------------------------------------------------*/
31
32#include "base/cs_defs.h"
33
34/*----------------------------------------------------------------------------*/
35
36typedef struct _cs_paramedmem_remapper_t cs_paramedmem_remapper_t;
37
38/*----------------------------------------------------------------------------*/
51/*----------------------------------------------------------------------------*/
52
53cs_paramedmem_remapper_t *
54cs_paramedmem_remapper_create(char *name,
55 const char *sel_criteria,
56 char *file_name,
57 char *mesh_name,
58 cs_real_t center[3],
59 cs_real_t radius);
60
61/*----------------------------------------------------------------------------*/
69/*----------------------------------------------------------------------------*/
70
71cs_paramedmem_remapper_t *
72cs_paramedmem_remapper_by_name_try(const char *name);
73
74/*----------------------------------------------------------------------------*/
95/*----------------------------------------------------------------------------*/
96
97cs_real_t *
98cs_paramedmem_remap_field(cs_paramedmem_remapper_t *r,
99 char *field_name,
100 cs_real_t default_val,
101 int time_choice,
102 double tval);
103
104/*----------------------------------------------------------------------------*/
116/*----------------------------------------------------------------------------*/
117
118cs_real_t *
119cs_paramedmem_remap_field_one_time(cs_paramedmem_remapper_t *r,
120 char *field_name,
121 cs_real_t default_val,
122 int dt,
123 int it);
124
125/*----------------------------------------------------------------------------*/
132/*----------------------------------------------------------------------------*/
133
134void
135cs_paramedmem_remapper_translate(cs_paramedmem_remapper_t *r,
136 cs_real_t translation[3]);
137
138/*----------------------------------------------------------------------------*/
147/*----------------------------------------------------------------------------*/
148
149void
150cs_paramedmem_remapper_rotate(cs_paramedmem_remapper_t *r,
151 cs_real_t invariant[3],
152 cs_real_t axis[3],
153 cs_real_t angle);
154
155/*----------------------------------------------------------------------------*/
159/*----------------------------------------------------------------------------*/
160
161void
162cs_paramedmem_remapper_destroy_all(void);
163
164/*----------------------------------------------------------------------------*/
165
166#endif /* CS_PARAMEDMEM_REMAPPER_HXX */
cs_defs.h
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:332
dt
@ dt
Definition: cs_field_pointer.h:61
cs_paramedmem_remap_field
cs_real_t * cs_paramedmem_remap_field(cs_paramedmem_remapper_t *r, char *field_name, cs_real_t default_val, int time_choice, double tval)
Interpolate a given field on the local mesh for a given time.
Definition: cs_paramedmem_remapper.cxx:712
cs_paramedmem_remapper_by_name_try
cs_paramedmem_remapper_t * cs_paramedmem_remapper_by_name_try(const char *name)
get a remapper by its name
Definition: cs_paramedmem_remapper.cxx:558
cs_paramedmem_remap_field_one_time
cs_real_t * cs_paramedmem_remap_field_one_time(cs_paramedmem_remapper_t *r, char *field_name, cs_real_t default_val, int dt, int it)
Remaps a field from the med file to the local mesh for a given time.
Definition: cs_paramedmem_remapper.cxx:597
cs_paramedmem_remapper_create
cs_paramedmem_remapper_t * cs_paramedmem_remapper_create(char *name, const char *sel_criteria, char *file_name, char *mesh_name, cs_real_t center[3], cs_real_t radius)
Creates a new cs_paramedmem_remapper_t instance.
Definition: cs_paramedmem_remapper.cxx:500
cs_paramedmem_remapper_rotate
void cs_paramedmem_remapper_rotate(cs_paramedmem_remapper_t *r, cs_real_t invariant[3], cs_real_t axis[3], cs_real_t angle)
Rotate the mesh using a center point, axis and angle.
Definition: cs_paramedmem_remapper.cxx:840
cs_paramedmem_remapper_destroy_all
void cs_paramedmem_remapper_destroy_all(void)
Destroy all remappers.
Definition: cs_paramedmem_remapper.cxx:872
cs_paramedmem_remapper_translate
void cs_paramedmem_remapper_translate(cs_paramedmem_remapper_t *r, cs_real_t translation[3])
translate the mesh using a given vector
Definition: cs_paramedmem_remapper.cxx:808
cs_paramedmem_remapper_t
struct _cs_paramedmem_remapper_t cs_paramedmem_remapper_t
Definition: cs_paramedmem_remapper.h:36