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
|
#!/usr/bin/env python
#-------------------------------------------------------------------------------
# This file is part of Code_Saturne, a general-purpose CFD tool.
#
# Copyright (C) 1998-2019 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.
#-------------------------------------------------------------------------------
import os
#===============================================================================
# Local functions
#===============================================================================
#===============================================================================
# Defining parameters for a calculation domain
#===============================================================================
def domain_prepare_data_add(domain):
"""
Additional steps to prepare data
(called in data preparation stage, between copy of files
in DATA and copy of link of restart files as defined by domain).
"""
return
#-------------------------------------------------------------------------------
def domain_copy_results_add(domain):
"""
Additional steps to copy results or cleanup execution directory
(called at beginning of data copy stage).
"""
return
#-------------------------------------------------------------------------------
def define_domain_parameters(domain):
"""
Define domain execution parameters.
"""
# Reusing output from previous runs
#----------------------------------
# By default, upon restart, if the previous mesh is available in the
# checkpoint, preprocessing is skipped. To allow additional preprocessing,
# set:
# domain.preprocess_on_restart = True
# To use the output of a previous Preprocessor (mesh import) run, set:
# domain.mesh_input = 'RESU/<run_id>/mesh_input'
# To use the mesh output of a previous solver run, set:
# domain.mesh_input = 'RESU/<run_id>/mesh_output'
# To reuse a previous partitioning, set:
# domain.partition_input = 'RESU/<run_id>/partition'
# To continue a calculation from a previous checkpoint, set:
# domain.restart_input = 'RESU/<run_id>/checkpoint'
if domain.param == None:
domain.preprocess_on_restart = False
domain.mesh_input = None
domain.partition_input = None
domain.restart_input = None
# Defining meshes to import (only if domain.mesh_input = None)
#-------------------------------------------------------------
# A case-specific mesh directory can be defined through domain.mesh_dir.
if domain.param == None:
domain.mesh_dir = None
# Mesh names can be given as absolute path names; otherwise, file are
# searched in the following directories, in the order:
# - the case mesh database directory, domain.mesh_dir (if defined)
# - the study mesh database directory, ../MESH directory (if present)
# - the user mesh database directory, see ~/.code_saturne.cfg
# - the global mesh database directory, see $prefix/etc/code_saturne.cfg
# Meshes should be defined as a list of strings defining mesh
# file names. If preprocessor options must be used for some meshes,
# a tuple containing a file name followed by additional options
# may be used instead of a simple file name, for example:
# domain.meshes = ['part1.des',
# ('part2_med', '--format', 'med',
# '--num', '2', '--reorient'),
# '~/meshdatabase/part3.unv']
if domain.param == None:
domain.meshes = None
# Logging arguments
#------------------
# Command-line arguments useful for logging, or determining the calculation
# type may be defined here, for example:
# domain.logging_args = '--logp'
if domain.param == None:
domain.logging_args = None
# Solver options
#---------------
# Running the solver may be deactivated by setting
# domain.exec_solver = False
# The type of run may be determined using domain.solver_args.
# For example:
# domain.solver_args = '--quality'
# allows activation of elementary mesh quality criteria output, while:
# domain.solver_args = '--benchmark'
# allows running basic linear algebra operation benchmarks.
# To run the solver's preprocessing stage only (mesh joining, smoothing,
# and other modifications), use:
# domain.solver_args = '--preprocess'
if domain.param == None:
domain.exec_solver = True
domain.solver_args = None
# Compile and build options
#--------------------------
# Additionnal compiler flags may be passed to the C, C++, or Fortran
# compilers, and libraries may be added, in case linking of user
# functions against external libraries is needed.
# Note that compiler flags will be added before the default flags;
# this helps ensure added search paths have priority, but also implies
# that user optimization options may be superceded by the default ones.
if domain.param == None:
domain.compile_cflags = None
domain.compile_cxxflags = None
domain.compile_fcflags = None
domain.compile_libs = None
# Debugging options
#------------------
# To run the solver through a debugger, domain.debug should contain
# the matching command-line arguments, such as:
# domain.debug = '--debugger=gdb'
# or (for Valgrind):
# domain.debug = 'valgrind --tool=memcheck'
# or (for Valgrind and ddd):
# domain.debug = '--debugger=ddd valgrind --tool=memcheck --vgdb-error=1'
if domain.param == None:
domain.debug = None
# import pprint
# pprint.pprint(domain.__dict__)
return
#-------------------------------------------------------------------------------
# End
#-------------------------------------------------------------------------------
|
