Beta release!
Please note that the library has not been "officially" released. While we continue to work on the documentation, these web pages are likely to contain broken links and documents in draft form. Please send an email to

oomph-lib AT maths DOT man DOT ac DOT uk
if you wish to be informed of the library's "official" release.

BrethertonElement< ELEMENT > Class Template Reference

List of all members.

Detailed Description

template<class ELEMENT>
class BrethertonElement< ELEMENT >

"Bretherton element" is a fluid element (of type ELEMENT) for which the (inflow) velocity at those nodes that are located on a specified Mesh boundary is prescribed by Dirichlet boundary conditions. The key is that prescribed velocity profile can be a function of some external Data -- this dependency must be taken into account when computing the element's Jacobian matrix.

This element type is useful, for instance, in the Bretherton problem, where the parabolic "inflow" profile is a function of the film thickness (represented by Spine heights) at the "outflow".

Definition at line 156 of file bretherton.cc.


Public Types
typedef void(*)	InflowFctPt (const Vector< double > &x, Vector< double > &veloc)
	Typedef for pointer (global) function that specifies the the inflow.
Public Member Functions
	BrethertonElement ()
	Constructor: Call the constructor of the underlying element.
void	activate_inflow_dependency_on_external_data (const Vector< Data * > &inflow_ext_data, const unsigned &inflow_boundary, InflowFctPt inflow_fct_pt)
	Activate the dependency of the "inflow" on the external data. Pass the vector of pointers to the external Data that affects the inflow, the id of the boundary on which the inflow condition is to be applied and the function pointer to to the global function that defines the inflow.
void	assign_local_eqn_numbers ()
void	get_jacobian (Vector< double > &residuals, DenseMatrix< double > &jacobian)
Private Member Functions
void	reassign_inflow ()
	For all nodes that are located on specified boundary re-assign the inflow velocity, using the function pointed to by the function pointer.
Private Attributes
Vector< Data * >	Inflow_ext_data
	Storage for the external Data that affects the inflow.
DenseMatrix< int >	Inflow_ext_data_eqn
	Storage for the local equation numbers associated the Data values that affect the inflow.
unsigned	Inflow_boundary
	Number of the inflow boundary in the global mesh.
InflowFctPt	Inflow_fct_pt
	Function pointer to the global function that specifies the inflow velocity profile on the global mesh boundary Inflow_boundary.

Member Typedef Documentation

template<class ELEMENT>

typedef void(*) BrethertonElement< ELEMENT >::InflowFctPt(const Vector< double > &x, Vector< double > &veloc)

Typedef for pointer (global) function that specifies the the inflow.

Definition at line 163 of file bretherton.cc.

Constructor & Destructor Documentation

template<class ELEMENT>

BrethertonElement< ELEMENT >::BrethertonElement ( ) [inline]

Constructor: Call the constructor of the underlying element.

Definition at line 166 of file bretherton.cc.

Member Function Documentation

template<class ELEMENT>

void BrethertonElement< ELEMENT >::activate_inflow_dependency_on_external_data	(	const Vector< Data * > &	inflow_ext_data,
		const unsigned &	inflow_boundary,
		InflowFctPt	inflow_fct_pt
	)			`[inline]`

Activate the dependency of the "inflow" on the external data. Pass the vector of pointers to the external Data that affects the inflow, the id of the boundary on which the inflow condition is to be applied and the function pointer to to the global function that defines the inflow.

Definition at line 174 of file bretherton.cc.

References BrethertonElement< ELEMENT >::Inflow_boundary, BrethertonElement< ELEMENT >::Inflow_ext_data, and BrethertonElement< ELEMENT >::Inflow_fct_pt.

template<class ELEMENT>

void BrethertonElement< ELEMENT >::assign_local_eqn_numbers ( ) [inline]

short Overload assign local equation numbers: Add the dependency on the external Data that affects the inflow profile

Definition at line 195 of file bretherton.cc.

References BrethertonElement< ELEMENT >::Inflow_ext_data, and BrethertonElement< ELEMENT >::Inflow_ext_data_eqn.

template<class ELEMENT>

void BrethertonElement< ELEMENT >::get_jacobian	(	Vector< double > &	residuals,
		DenseMatrix< double > &	jacobian
	)			`[inline]`

Overloaded Jacobian computation: Computes the Jacobian of the underlying element and then adds the FD operations to evaluate the derivatives w.r.t. the Data values that affect the inflow.

Definition at line 263 of file bretherton.cc.

References BrethertonElement< ELEMENT >::Inflow_ext_data, BrethertonElement< ELEMENT >::Inflow_ext_data_eqn, and BrethertonElement< ELEMENT >::reassign_inflow().

template<class ELEMENT>

void BrethertonElement< ELEMENT >::reassign_inflow ( ) [inline, private]

For all nodes that are located on specified boundary re-assign the inflow velocity, using the function pointed to by the function pointer.

Definition at line 341 of file bretherton.cc.

References BrethertonElement< ELEMENT >::Inflow_boundary, and BrethertonElement< ELEMENT >::Inflow_fct_pt.

Referenced by BrethertonElement< ELEMENT >::get_jacobian().