/usr/lib/python2.7/dist-packages/ffc/codegeneration.py is in python-ffc 1.4.0-1.
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 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 | """
Compiler stage 4: Code generation
---------------------------------
This module implements the generation of C++ code for the body of each
UFC function from an (optimized) intermediate representation (OIR).
"""
# Copyright (C) 2009-2013 Anders Logg
#
# This file is part of FFC.
#
# FFC is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# FFC 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 Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with FFC. If not, see <http://www.gnu.org/licenses/>.
#
# Modified by Mehdi Nikbakht 2010
# Modified by Martin Alnaes, 2013
#
# First added: 2009-12-16
# Last changed: 2014-03-19
# FFC modules
from ffc.log import info, begin, end, debug_code
from ffc.cpp import format, indent
from ffc.cpp import set_exception_handling
#from ffc.cpp import set_float_formatting, set_exception_handling
# FFC code generation modules
from ffc.evaluatebasis import _evaluate_basis, _evaluate_basis_all
from ffc.evaluatebasisderivatives import _evaluate_basis_derivatives
from ffc.evaluatebasisderivatives import _evaluate_basis_derivatives_all
from ffc.evaluatedof import evaluate_dof_and_dofs, affine_weights
from ffc.interpolatevertexvalues import interpolate_vertex_values
from ffc.representation import pick_representation
# Errors issued for non-implemented functions
def _not_implemented(function_name, return_null=False):
body = format["exception"]("%s not yet implemented." % function_name)
if return_null:
body += "\n" + format["return"](0)
return body
def generate_code(ir, prefix, parameters):
"Generate code from intermediate representation."
begin("Compiler stage 4: Generating code")
# FIXME: Document option -fconvert_exceptions_to_warnings
# FIXME: Remove option epsilon and just rely on precision?
# Set code generation parameters
# set_float_formatting(int(parameters["precision"]))
set_exception_handling(parameters["convert_exceptions_to_warnings"])
# Extract representations
ir_elements, ir_dofmaps, ir_integrals, ir_forms = ir
# Generate code for elements
info("Generating code for %d element(s)" % len(ir_elements))
code_elements = [_generate_element_code(ir, prefix, parameters) for ir in ir_elements]
# Generate code for dofmaps
info("Generating code for %d dofmap(s)" % len(ir_dofmaps))
code_dofmaps = [_generate_dofmap_code(ir, prefix, parameters) for ir in ir_dofmaps]
# Generate code for integrals
info("Generating code for integrals")
code_integrals = [_generate_integral_code(ir, prefix, parameters) for ir in ir_integrals]
# Generate code for forms
info("Generating code for forms")
code_forms = [_generate_form_code(ir, prefix, parameters) for ir in ir_forms]
end()
return code_elements, code_dofmaps, code_integrals, code_forms
def _generate_element_code(ir, prefix, parameters):
"Generate code for finite element from intermediate representation."
# Skip code generation if ir is None
if ir is None: return None
# Prefetch formatting to speedup code generation
ret = format["return"]
classname = format["classname finite_element"]
do_nothing = format["do nothing"]
create = format["create foo"]
# Codes generated together
(evaluate_dof_code, evaluate_dofs_code) = evaluate_dof_and_dofs(ir["evaluate_dof"])
# Generate code
code = {}
code["classname"] = classname(prefix, ir["id"])
code["members"] = ""
code["constructor"] = do_nothing
code["constructor_arguments"] = ""
code["initializer_list"] = ""
code["destructor"] = do_nothing
code["signature"] = ret('"%s"' % ir["signature"])
code["cell_shape"] = ret(format["cell"](ir["cell_shape"]))
code["topological_dimension"] = ret(ir["topological_dimension"])
code["geometric_dimension"] = ret(ir["geometric_dimension"])
code["space_dimension"] = ret(ir["space_dimension"])
code["value_rank"] = ret(ir["value_rank"])
code["value_dimension"] = _value_dimension(ir["value_dimension"])
code["evaluate_basis"] = _evaluate_basis(ir["evaluate_basis"])
code["evaluate_basis_all"] = _evaluate_basis_all(ir["evaluate_basis"])
code["evaluate_basis_derivatives"] = _evaluate_basis_derivatives(ir["evaluate_basis"])
code["evaluate_basis_derivatives_all"] = _evaluate_basis_derivatives_all(ir["evaluate_basis"])
code["evaluate_dof"] = evaluate_dof_code
code["evaluate_dofs"] = evaluate_dofs_code
code["interpolate_vertex_values"] = interpolate_vertex_values(ir["interpolate_vertex_values"])
code["map_from_reference_cell"] = _not_implemented("map_from_reference_cell")
code["map_to_reference_cell"] = _not_implemented("map_to_reference_cell")
code["num_sub_elements"] = ret(ir["num_sub_elements"])
code["create_sub_element"] = _create_foo(prefix, "finite_element", ir["create_sub_element"])
code["create"] = ret(create(code["classname"]))
# Postprocess code
_postprocess_code(code, parameters)
return code
def _generate_dofmap_code(ir, prefix, parameters):
"Generate code for dofmap from intermediate representation."
# Skip code generation if ir is None
if ir is None: return None
# Prefetch formatting to speedup code generation
ret = format["return"]
classname = format["classname dofmap"]
declare = format["declaration"]
assign = format["assign"]
do_nothing = format["do nothing"]
switch = format["switch"]
f_int = format["int"]
f_d = format["argument dimension"]
create = format["create foo"]
# Generate code
code = {}
code["classname"] = classname(prefix, ir["id"])
code["members"] = ""
code["constructor"] = do_nothing
code["constructor_arguments"] = ""
code["initializer_list"] = ""
code["destructor"] = do_nothing
code["signature"] = ret('"%s"' % ir["signature"])
code["needs_mesh_entities"] = _needs_mesh_entities(ir["needs_mesh_entities"])
code["topological_dimension"] = ret(ir["topological_dimension"])
code["geometric_dimension"] = ret(ir["geometric_dimension"])
code["global_dimension"] = _global_dimension(ir["global_dimension"])
code["local_dimension"] = ret(ir["local_dimension"])
code["num_facet_dofs"] = ret(ir["num_facet_dofs"])
code["num_entity_dofs"] = switch(f_d, [ret(num) for num in ir["num_entity_dofs"]], ret(f_int(0)))
code["tabulate_dofs"] = _tabulate_dofs(ir["tabulate_dofs"])
code["tabulate_facet_dofs"] = _tabulate_facet_dofs(ir["tabulate_facet_dofs"])
code["tabulate_entity_dofs"] = _tabulate_entity_dofs(ir["tabulate_entity_dofs"])
code["tabulate_coordinates"] = _tabulate_coordinates(ir["tabulate_coordinates"])
code["num_sub_dofmaps"] = ret(ir["num_sub_dofmaps"])
code["create_sub_dofmap"] = _create_foo(prefix, "dofmap", ir["create_sub_dofmap"])
code["create"] = ret(create(code["classname"]))
# Postprocess code
_postprocess_code(code, parameters)
return code
def _generate_integral_code(ir, prefix, parameters):
"Generate code for integrals from intermediate representation."
# Skip code generation if ir is None
if ir is None: return None
# Select representation
r = pick_representation(ir["representation"])
# Generate code
code = r.generate_integral_code(ir, prefix, parameters)
# Indent code (unused variables should already be removed)
if ir["representation"] != "uflacs": # FIXME: Remove this quick hack
_indent_code(code)
return code
def _generate_form_code(ir, prefix, parameters):
"Generate code for form from intermediate representation."
# Skip code generation if ir is None
if ir is None: return None
# Prefetch formatting to speedup code generation
ret = format["return"]
classname = format["classname form"]
do_nothing = format["do nothing"]
# Generate code
code = {}
code["classname"] = classname(prefix, ir["id"])
code["members"] = ""
code["constructor"] = do_nothing
code["constructor_arguments"] = ""
code["initializer_list"] = ""
code["destructor"] = do_nothing
code["signature"] = ret('"%s"' % ir["signature"])
code["rank"] = ret(ir["rank"])
code["num_coefficients"] = ret(ir["num_coefficients"])
code["num_cell_domains"] = ret(ir["num_cell_domains"])
code["num_exterior_facet_domains"] = ret(ir["num_exterior_facet_domains"])
code["num_interior_facet_domains"] = ret(ir["num_interior_facet_domains"])
code["num_point_domains"] = ret(ir["num_point_domains"])
code["num_custom_domains"] = ret(ir["num_custom_domains"])
code["has_cell_integrals"] = _has_foo_integrals(ir, "cell")
code["has_exterior_facet_integrals"] = _has_foo_integrals(ir, "exterior_facet")
code["has_interior_facet_integrals"] = _has_foo_integrals(ir, "interior_facet")
code["has_point_integrals"] = _has_foo_integrals(ir, "point")
code["has_custom_integrals"] = _has_foo_integrals(ir, "custom")
code["create_finite_element"] = _create_foo(prefix, "finite_element", ir["create_finite_element"])
code["create_dofmap"] = _create_foo(prefix, "dofmap", ir["create_dofmap"])
code["create_cell_integral"] = _create_foo_integral(ir, "cell", prefix)
code["create_exterior_facet_integral"] = _create_foo_integral(ir, "exterior_facet", prefix)
code["create_interior_facet_integral"] = _create_foo_integral(ir, "interior_facet", prefix)
code["create_point_integral"] = _create_foo_integral(ir, "point", prefix)
code["create_custom_integral"] = _create_foo_integral(ir, "custom", prefix)
code["create_default_cell_integral"] = _create_default_foo_integral(ir, "cell", prefix)
code["create_default_exterior_facet_integral"] = _create_default_foo_integral(ir, "exterior_facet", prefix)
code["create_default_interior_facet_integral"] = _create_default_foo_integral(ir, "interior_facet", prefix)
code["create_default_point_integral"] = _create_default_foo_integral(ir, "point", prefix)
code["create_default_custom_integral"] = _create_default_foo_integral(ir, "custom", prefix)
# Postprocess code
_postprocess_code(code, parameters)
#debug_code(code, "form")
return code
#--- Code generation for non-trivial functions ---
def _value_dimension(ir):
"Generate code for value_dimension."
ret = format["return"]
axis = format["argument axis"]
f_int = format["int"]
if ir == ():
return ret(1)
return format["switch"](axis, [ret(n) for n in ir], ret(f_int(0)))
def _needs_mesh_entities(ir):
"""
Generate code for needs_mesh_entities. ir is a list of num dofs
per entity.
"""
ret = format["return"]
boolean = format["bool"]
dimension = format["argument dimension"]
return format["switch"](dimension, [ret(boolean(c)) for c in ir], ret(boolean(False)))
def _global_dimension(ir):
"""Generate code for global_dimension. ir[0] is a list of num dofs per
entity."""
num_dofs = ir[0]
component = format["component"]
entities = format["num entities"]
dimension = format["inner product"]([format["int"](d) for d in num_dofs],
[component(entities, d)
for d in range(len(num_dofs))])
# Handle global "elements" if any
if ir[1]:
dimension = format["add"]([dimension, format["int"](ir[1])])
try:
dimension = format["int"](eval(dimension))
except:
pass
code = format["return"](dimension)
return code
def _tabulate_facet_dofs(ir):
"Generate code for tabulate_facet_dofs."
assign = format["assign"]
component = format["component"]
dofs = format["argument dofs"]
cases = ["\n".join(assign(component(dofs, i), dof)
for (i, dof) in enumerate(facet))
for facet in ir]
return format["switch"](format["facet"](None), cases)
def _tabulate_dofs(ir):
"Generate code for tabulate_dofs."
# Prefetch formats
add = format["addition"]
iadd = format["iadd"]
multiply = format["multiply"]
assign = format["assign"]
component = format["component"]
entity_index = format["entity index"]
num_entities_format = format["num entities"]
unsigned_int = format["uint declaration"]
dofs_variable = format["argument dofs"]
if ir is None:
return assign(component(dofs_variable, 0), 0)
# Extract representation
(dofs_per_element, num_dofs_per_element, num_entities, need_offset, fakes) = ir
# Declare offset if needed
code = []
offset_name = "0"
if need_offset:
offset_name = "offset"
code.append(format["declaration"](unsigned_int, offset_name, 0))
# Generate code for each element
i = 0
for (no, num_dofs) in enumerate(dofs_per_element):
# Handle fakes (Space of reals)
if fakes[no] and num_dofs_per_element[no] == 1:
code.append(assign(component(dofs_variable, i), offset_name))
if offset_name != "0":
code.append(iadd(offset_name, 1))
i += 1
continue
# Generate code for each degree of freedom for each dimension
for (dim, num) in enumerate(num_dofs):
# Ignore if no dofs for this dimension
if not num[0]: continue
for (k, dofs) in enumerate(num):
v = multiply([len(num[k]), component(entity_index, (dim, k))])
for (j, dof) in enumerate(dofs):
value = add([offset_name, v, j])
code.append(assign(component(dofs_variable, dof+i), value))
# Update offset corresponding to mesh entity:
if need_offset:
addition = multiply([len(num[0]),
component(num_entities_format, dim)])
code.append(iadd("offset", addition))
i += num_dofs_per_element[no]
return "\n".join(code)
def _tabulate_coordinates(ir):
"Generate code for tabulate_coordinates."
# Raise error if tabulate_coordinates is ill-defined
if not ir:
msg = "tabulate_coordinates is not defined for this element"
return format["exception"](msg)
# Extract formats:
inner_product = format["inner product"]
component = format["component"]
precision = format["float"]
assign = format["assign"]
f_x = format["vertex_coordinates"]
coordinates = format["argument coordinates"]
# Extract coordinates and cell dimension
gdim = ir["gdim"]
tdim = ir["tdim"]
#cell_dim = len(ir[0])
# Aid mapping points from reference to physical element
coefficients = affine_weights(tdim)
# Generate code for each point and each component
code = []
for (i, coordinate) in enumerate(ir["points"]):
w = coefficients(coordinate)
for j in range(gdim):
# Compute physical coordinate
coords = [component(f_x(), (k*gdim + j,)) for k in range(tdim + 1)]
value = inner_product(w, coords)
# Assign coordinate
code.append(assign(component(coordinates, (i, j)), value))
return "\n".join(code)
def _tabulate_entity_dofs(ir):
"Generate code for tabulate_entity_dofs."
# Extract variables from ir
entity_dofs, num_dofs_per_entity = ir
# Prefetch formats
assign = format["assign"]
component = format["component"]
f_d = format["argument dimension"]
f_i = format["argument entity"]
dofs = format["argument dofs"]
# Add check that dimension and number of mesh entities is valid
dim = len(num_dofs_per_entity)
excpt = format["exception"]("%s is larger than dimension (%d)" % (f_d, dim - 1))
code = [format["if"]("%s > %d" % (f_d, dim-1), excpt)]
# Generate cases for each dimension:
all_cases = ["" for d in range(dim)]
for d in range(dim):
# Ignore if no entities for this dimension
if num_dofs_per_entity[d] == 0: continue
# Add check that given entity is valid:
num_entities = len(entity_dofs[d].keys())
excpt = format["exception"]("%s is larger than number of entities (%d)"
% (f_i, num_entities - 1))
check = format["if"]("%s > %d" % (f_i, num_entities - 1), excpt)
# Generate cases for each mesh entity
cases = ["\n".join(assign(component(dofs, j), dof)
for (j, dof) in enumerate(entity_dofs[d][entity]))
for entity in range(num_entities)]
# Generate inner switch with preceding check
all_cases[d] = "\n".join([check, format["switch"](f_i, cases)])
# Generate outer switch
code.append(format["switch"](f_d, all_cases))
return "\n".join(code)
#--- Utility functions ---
def _create_foo(prefix, class_name, postfix, numbers=None):
"Generate code for create_<foo>."
f_i = format["argument sub"]
ret = format["return"]
create = format["create foo"]
class_names = ["%s_%s_%d" % (prefix.lower(), class_name, i) for i in postfix]
cases = [ret(create(name)) for name in class_names]
default = ret(0)
return format["switch"](f_i, cases, default=default, numbers=numbers)
def _create_foo_integral(ir, integral_type, prefix):
"Generate code for create_<foo>_integral."
class_name = integral_type + "_integral_" + str(ir["id"])
postfix = ir["create_" + integral_type + "_integral"]
return _create_foo(prefix, class_name, postfix, numbers=postfix)
def _has_foo_integrals(ir, integral_type):
ret = format["return"]
b = format["bool"]
i = ir["has_%s_integrals" % integral_type]
return ret(b(i))
def _create_default_foo_integral(ir, integral_type, prefix):
"Generate code for create_default_<foo>_integral."
ret = format["return"]
postfix = ir["create_default_" + integral_type + "_integral"]
if postfix is None:
return ret(0)
else:
create = format["create foo"]
class_name = integral_type + "_integral_" + str(ir["id"])
name = "%s_%s_%s" % (prefix.lower(), class_name, postfix)
return ret(create(name))
def _postprocess_code(code, parameters):
"Postprocess generated code."
_indent_code(code)
_remove_code(code, parameters)
def _indent_code(code):
"Indent code that should be indented."
for key in code:
if not key in ("classname", "members", "constructor_arguments", "initializer_list", "additional_includes_set", "restrict"):
code[key] = indent(code[key], 4)
def _remove_code(code, parameters):
"Remove code that should not be generated."
for key in code:
flag = "no-" + key
if flag in parameters and parameters[flag]:
msg = "// Function %s not generated (compiled with -f%s)" % (key, flag)
code[key] = format["exception"](msg)
|