/usr/lib/python2.7/dist-packages/ufl/formoperators.py is in python-ufl 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 | "Various high level ways to transform a complete Form into a new Form."
# Copyright (C) 2008-2014 Martin Sandve Alnes
#
# This file is part of UFL.
#
# UFL 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.
#
# UFL 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 UFL. If not, see <http://www.gnu.org/licenses/>.
#
# Modified by Anders Logg, 2009
from itertools import izip, chain
from ufl.log import error
from ufl.assertions import ufl_assert
from ufl.form import Form, as_form
from ufl.expr import Expr
from ufl.split_functions import split
from ufl.exprcontainers import ExprList, ExprMapping
from ufl.variable import Variable
from ufl.finiteelement import MixedElement
from ufl.argument import Argument
from ufl.coefficient import Coefficient
from ufl.differentiation import CoefficientDerivative
from ufl.constantvalue import is_true_ufl_scalar, as_ufl
from ufl.indexed import Indexed
from ufl.indexing import FixedIndex, MultiIndex
from ufl.tensors import as_tensor
from ufl.sorting import sorted_expr
# An exception to the rule that ufl.* does not depend on ufl.algorithms.* ...
from ufl.algorithms import compute_form_adjoint, \
compute_form_action, \
compute_energy_norm, \
compute_form_lhs, \
compute_form_rhs, \
compute_form_functional, \
expand_derivatives
# Part of the external interface
from ufl.algorithms import replace
def lhs(form):
"""UFL form operator:
Given a combined bilinear and linear form,
extract the left hand side (bilinear form part).
Example:
a = u*v*dx + f*v*dx
a = lhs(a) -> u*v*dx
"""
form = as_form(form)
form = expand_derivatives(form)
return compute_form_lhs(form)
def rhs(form):
"""UFL form operator:
Given a combined bilinear and linear form,
extract the right hand side (negated linear form part).
Example:
a = u*v*dx + f*v*dx
L = rhs(a) -> -f*v*dx
"""
form = as_form(form)
form = expand_derivatives(form)
return compute_form_rhs(form)
def system(form):
"UFL form operator: Split a form into the left hand side and right hand side, see lhs and rhs."
return lhs(form), rhs(form)
def functional(form): # TODO: Does this make sense for anything other than testing?
"UFL form operator: Extract the functional part of form."
form = as_form(form)
form = expand_derivatives(form)
return compute_form_functional(form)
def action(form, coefficient=None):
"""UFL form operator:
Given a bilinear form, return a linear form
with an additional coefficient, representing the
action of the form on the coefficient. This can be
used for matrix-free methods."""
form = as_form(form)
form = expand_derivatives(form)
return compute_form_action(form, coefficient)
def energy_norm(form, coefficient=None):
"""UFL form operator:
Given a bilinear form, return a linear form
with an additional coefficient, representing the
action of the form on the coefficient. This can be
used for matrix-free methods."""
form = as_form(form)
form = expand_derivatives(form)
return compute_energy_norm(form, coefficient)
def adjoint(form, reordered_arguments=None):
"""UFL form operator:
Given a combined bilinear form, compute the adjoint form by
changing the ordering (count) of the test and trial functions.
By default, new Argument objects will be created with
opposite ordering. However, if the adjoint form is to
be added to other forms later, their arguments must match.
In that case, the user must provide a tuple reordered_arguments=(u2,v2).
"""
form = as_form(form)
form = expand_derivatives(form)
return compute_form_adjoint(form, reordered_arguments)
def zero_lists(shape):
ufl_assert(len(shape) > 0, "Invalid shape.")
if len(shape) == 1:
return [0]*shape[0]
else:
return [zero_lists(shape[1:]) for i in range(shape[0])]
def set_list_item(li, i, v):
# Get to the innermost list
if len(i) > 1:
for j in i[:-1]:
li = li[j]
# Set item in innermost list
li[i[-1]] = v
def _handle_derivative_arguments(form, coefficient, argument):
# Wrap single coefficient in tuple for uniform treatment below
if isinstance(coefficient, (list,tuple)):
coefficients = tuple(coefficient)
else:
coefficients = (coefficient,)
if argument is None:
# Try to create argument if not provided
if not all(isinstance(c, Coefficient) for c in coefficients):
error("Can only create arguments automatically for non-indexed coefficients.")
# Get existing arguments from form and position the new one with the next argument number
from ufl.algorithms import extract_arguments
form_arguments = extract_arguments(form)
numbers = sorted(set(arg.number() for arg in form_arguments))
number = max(numbers + [-1]) + 1
# Don't know what to do with parts, let the user sort it out in that case
parts = set(arg.part() for arg in form_arguments)
ufl_assert(len(parts - set((None,))) == 0, "Not expecting parts here, provide your own arguments.")
part = None
# Create argument and split it if in a mixed space
elements = [c.element() for c in coefficients]
if len(elements) > 1:
elm = MixedElement(*elements)
arguments = split(Argument(elm, number, part))
else:
elm, = elements
arguments = (Argument(elm, number, part),)
else:
# Wrap single argument in tuple for uniform treatment below
if isinstance(argument, (list,tuple)):
arguments = tuple(argument)
else:
n = len(coefficients)
if n == 1:
arguments = (argument,)
else:
if argument.shape() == (n,):
arguments = tuple(argument[i] for i in range(n))
else:
arguments = split(argument)
# Build mapping from coefficient to argument
m = {}
for (c, a) in izip(coefficients, arguments):
ufl_assert(c.shape() == a.shape(), "Coefficient and argument shapes do not match!")
if isinstance(c, Coefficient):
m[c] = a
else:
ufl_assert(isinstance(c, Indexed), "Invalid coefficient type for %s" % repr(c))
f, i = c.operands()
ufl_assert(isinstance(f, Coefficient), "Expecting an indexed coefficient, not %s" % repr(f))
ufl_assert(isinstance(i, MultiIndex) and all(isinstance(j, FixedIndex) for j in i),
"Expecting one or more fixed indices, not %s" % repr(i))
i = tuple(int(j) for j in i)
if f not in m:
m[f] = {}
m[f][i] = a
# Merge coefficient derivatives (arguments) based on indices
for c, p in m.iteritems():
if isinstance(p, dict):
a = zero_lists(c.shape())
for i, g in p.iteritems():
set_list_item(a, i, g)
m[c] = as_tensor(a)
# Wrap and return generic tuples
items = sorted(m.items(), key=lambda x: x[0].count())
coefficients = ExprList(*[item[0] for item in items])
arguments = ExprList(*[item[1] for item in items])
return coefficients, arguments
def derivative(form, coefficient, argument=None, coefficient_derivatives=None):
"""UFL form operator:
Compute the Gateaux derivative of form w.r.t. coefficient in direction of argument.
If the argument is omitted, a new Argument is created
in the same space as the coefficient, with argument number
one higher than the highest one in the form.
The resulting form has one additional Argument
in the same finite element space as the coefficient.
A tuple of Coefficients may be provided in place of
a single Coefficient, in which case the new Argument
argument is based on a MixedElement created from this tuple.
An indexed Coefficient from a mixed space may be provided,
in which case the argument should be in the corresponding
subspace of the coefficient space.
If provided, coefficient_derivatives should be a mapping from
Coefficient instances to their derivatives w.r.t. 'coefficient'.
"""
coefficients, arguments = _handle_derivative_arguments(form, coefficient, argument)
if coefficient_derivatives is None:
coefficient_derivatives = ExprMapping()
else:
cd = []
for k in sorted_expr(coefficient_derivatives.keys()):
cd += [as_ufl(k), as_ufl(coefficient_derivatives[k])]
coefficient_derivatives = ExprMapping(*cd)
# Got a form? Apply derivatives to the integrands in turn.
if isinstance(form, Form):
integrals = []
for itg in form.integrals():
fd = CoefficientDerivative(itg.integrand(), coefficients,
arguments, coefficient_derivatives)
integrals.append(itg.reconstruct(fd))
return Form(integrals)
elif isinstance(form, Expr):
# What we got was in fact an integrand
return CoefficientDerivative(form, coefficients, arguments,
coefficient_derivatives)
error("Invalid argument type %s." % str(type(form)))
def sensitivity_rhs(a, u, L, v):
"""UFL form operator:
Compute the right hand side for a sensitivity calculation system.
The derivation behind this computation is as follows.
Assume a, L to be bilinear and linear forms
corresponding to the assembled linear system
Ax = b.
Where x is the vector of the discrete function corresponding to u.
Let v be some scalar variable this equation depends on.
Then we can write
0 = d/dv[Ax-b] = dA/dv x + A dx/dv - db/dv,
A dx/dv = db/dv - dA/dv x,
and solve this system for dx/dv, using the same bilinear form a
and matrix A from the original system.
Assume the forms are written
v = variable(v_expression)
L = IL(v)*dx
a = Ia(v)*dx
where IL and Ia are integrand expressions.
Define a Coefficient u representing the solution
to the equations. Then we can compute db/dv
and dA/dv from the forms
da = diff(a, v)
dL = diff(L, v)
and the action of da on u by
dau = action(da, u)
In total, we can build the right hand side of the system
to compute du/dv with the single line
dL = diff(L, v) - action(diff(a, v), u)
or, using this function
dL = sensitivity_rhs(a, u, L, v)
"""
msg = "Expecting (a, u, L, v), (bilinear form, function, linear form and scalar variable)."
ufl_assert(isinstance(a, Form), msg)
ufl_assert(isinstance(u, Coefficient), msg)
ufl_assert(isinstance(L, Form), msg)
ufl_assert(isinstance(v, Variable), msg)
ufl_assert(is_true_ufl_scalar(v), "Expecting scalar variable.")
from ufl.operators import diff
return diff(L, v) - action(diff(a, v), u)
|