GenericFunction¶
-
class
dolfin.cpp.function.
GenericFunction
(*args, **kwargs)¶ Bases:
dolfin.cpp.function.ufc_function
,dolfin.cpp.common.Variable
This is a common base class for functions. Functions can be evaluated at a given point and they can be restricted to a given cell in a finite element mesh. This functionality is implemented by sub-classes that implement the
eval
andrestrict
functions. DOLFIN provides two implementations of theGenericFunction
interface in the form of the classesFunction
andExpression
. Sub-classes may optionally implement theupdate
function that will be called prior to restriction when running in parallel.-
compute_vertex_values
()¶ Compute values at all mesh vertices.
Parameters: - double > & vertex_values (std::vector<) –
- Mesh & mesh (const) –
Return type: void
-
eval
()¶ Evaluate at given point (deprecated)
Parameters: - double > & values (Array<) –
- Array< double > & x (const) –
Return type: void
-
eval_cell
()¶ Evaluate at given point in given cell (deprecated)
Parameters: - double > & values (Array<) –
- Array< double > & x (const) –
- ufc::cell & cell (const) –
Return type: void
-
restrict
()¶ Restrict function to local cell (compute expansion coefficients w)
Parameters: - * w (double) –
- FiniteElement & element (const) –
- Cell & dolfin_cell (const) –
- double * coordinate_dofs (const) –
- ufc::cell & ufc_cell (const) –
Return type: void
-
thisown
¶ The membership flag
-
update
()¶ Update off-process ghost coefficients.
Return type: void
-
value_dimension
()¶ Return value dimension for given axis.
Parameters: i (std::size_t) – Return type: std::size_t
-
value_rank
()¶ Return value rank.
Return type: std::size_t
-
value_shape
()¶ Return value shape.
Return type: std::vector< std::size_t >
-
value_size
()¶ Evaluation at given point. Return value size (product of value dimensions)
Return type: std::size_t
-