The MeshWorker interface

Collaboration diagram for The MeshWorker interface:

Namespaces
	MeshWorker::Assembler
	MeshWorker

Classes
class	MeshWorker::Assembler::ResidualLocalBlocksToGlobalBlocks< VectorType >
class	MeshWorker::Assembler::MatrixLocalBlocksToGlobalBlocks< MatrixType, number >
class	MeshWorker::Assembler::MGMatrixLocalBlocksToGlobalBlocks< MatrixType, number >
class	MeshWorker::DoFInfo< dim, spacedim, number >
class	MeshWorker::DoFInfoBox< dim, DOFINFO >
class	MeshWorker::Assembler::Functional< number >
class	MeshWorker::Assembler::CellsAndFaces< number >
class	MeshWorker::IntegrationInfo< dim, spacedim >
class	MeshWorker::IntegrationInfoBox< dim, spacedim >
class	MeshWorker::LocalIntegrator< dim, spacedim, number >
class	MeshWorker::LocalResults< number >
class	MeshWorker::Assembler::ResidualSimple< VectorType >
class	MeshWorker::Assembler::MatrixSimple< MatrixType >
class	MeshWorker::Assembler::MGMatrixSimple< MatrixType >
class	MeshWorker::Assembler::SystemSimple< MatrixType, VectorType >
class	MeshWorker::VectorSelector
class	MeshWorker::VectorDataBase< dim, spacedim, Number >
class	MeshWorker::VectorData< VectorType, dim, spacedim >
class	MeshWorker::MGVectorData< VectorType, dim, spacedim >

Functions
template<class INFOBOX , class DOFINFO , int dim, int spacedim, class ITERATOR >
void	MeshWorker::cell_action (ITERATOR cell, DoFInfoBox< dim, DOFINFO > &dof_info, INFOBOX &info, const std_cxx11::function< void(DOFINFO &, typename INFOBOX::CellInfo &)> &cell_worker, const std_cxx11::function< void(DOFINFO &, typename INFOBOX::CellInfo &)> &boundary_worker, const std_cxx11::function< void(DOFINFO &, DOFINFO &, typename INFOBOX::CellInfo &, typename INFOBOX::CellInfo &)> &face_worker, const LoopControl &loop_control)
template<int dim, int spacedim, class DOFINFO , class INFOBOX , class ASSEMBLER , class ITERATOR >
void	MeshWorker::loop (ITERATOR begin, typename identity< ITERATOR >::type end, DOFINFO &dinfo, INFOBOX &info, const std_cxx11::function< void(DOFINFO &, typename INFOBOX::CellInfo &)> &cell_worker, const std_cxx11::function< void(DOFINFO &, typename INFOBOX::CellInfo &)> &boundary_worker, const std_cxx11::function< void(DOFINFO &, DOFINFO &, typename INFOBOX::CellInfo &, typename INFOBOX::CellInfo &)> &face_worker, ASSEMBLER &assembler, const LoopControl &lctrl=LoopControl())
template<int dim, int spacedim, class ITERATOR , class ASSEMBLER >
void	MeshWorker::integration_loop (ITERATOR begin, typename identity< ITERATOR >::type end, DoFInfo< dim, spacedim > &dof_info, IntegrationInfoBox< dim, spacedim > &box, const LocalIntegrator< dim, spacedim > &integrator, ASSEMBLER &assembler, const LoopControl &lctrl=LoopControl())

Detailed Description

A collection of classes and functions simplifying the coding of loops over all cells and faces. All classes and functions of this module are in the MeshWorker namespace, which also contains documentation on the usage.

Function Documentation

cell_action()

template<class INFOBOX , class DOFINFO , int dim, int spacedim, class ITERATOR >

void MeshWorker::cell_action	(	ITERATOR	cell,
		DoFInfoBox< dim, DOFINFO > &	dof_info,
		INFOBOX &	info,
		const std_cxx11::function< void(DOFINFO &, typename INFOBOX::CellInfo &)> &	cell_worker,
		const std_cxx11::function< void(DOFINFO &, typename INFOBOX::CellInfo &)> &	boundary_worker,
		const std_cxx11::function< void(DOFINFO &, DOFINFO &, typename INFOBOX::CellInfo &, typename INFOBOX::CellInfo &)> &	face_worker,
		const LoopControl &	loop_control
	)

The function called by loop() to perform the required actions on a cell and its faces. The three functions cell_worker, boundary_worker and face_worker are the same ones handed to loop(). While there we only run the loop over all cells, here, we do a single cell and, if necessary, its faces, interior and boundary.

Upon return, the DoFInfo objects in the DoFInfoBox are filled with the data computed on the cell and each of the faces. Thus, after the execution of this function, we are ready to call DoFInfoBox::assemble() to distribute the local data into global data.

Parameters

cell	is the cell we work on
dof_info	is the object into which local results are entered. It is expected to have been set up for the right types of data.
info	is the object containing additional data only needed for internal processing.
cell_worker	defines the local action on each cell.
boundary_worker	defines the local action on boundary faces
face_worker	defines the local action on interior faces.
loop_control	control structure to specify what actions should be performed.

Author

Guido Kanschat

Date

2010

Definition at line 175 of file loop.h.

loop()

template<int dim, int spacedim, class DOFINFO , class INFOBOX , class ASSEMBLER , class ITERATOR >

void MeshWorker::loop	(	ITERATOR	begin,
		typename identity< ITERATOR >::type	end,
		DOFINFO &	dinfo,
		INFOBOX &	info,
		const std_cxx11::function< void(DOFINFO &, typename INFOBOX::CellInfo &)> &	cell_worker,
		const std_cxx11::function< void(DOFINFO &, typename INFOBOX::CellInfo &)> &	boundary_worker,
		const std_cxx11::function< void(DOFINFO &, DOFINFO &, typename INFOBOX::CellInfo &, typename INFOBOX::CellInfo &)> &	face_worker,
		ASSEMBLER &	assembler,
		const LoopControl &	lctrl = LoopControl()
	)

The main work function of this namespace. It is a loop over all cells in an iterator range, in which cell_action() is called for each cell. Unilaterally refined interior faces are handled automatically by the loop. Most of the work in this loop is done in cell_action(), which also receives most of the parameters of this function. See the documentation there for more details.

If you don't want anything to be done on cells, interior or boundary faces to happen, simply pass the Null pointer to one of the function arguments.

Author

Guido Kanschat, 2009

Definition at line 383 of file loop.h.

integration_loop()

template<int dim, int spacedim, class ITERATOR , class ASSEMBLER >

void MeshWorker::integration_loop	(	ITERATOR	begin,
		typename identity< ITERATOR >::type	end,
		DoFInfo< dim, spacedim > &	dof_info,
		IntegrationInfoBox< dim, spacedim > &	box,
		const LocalIntegrator< dim, spacedim > &	integrator,
		ASSEMBLER &	assembler,
		const LoopControl &	lctrl = LoopControl()
	)

Simplified interface for loop() if specialized for integration, using the virtual functions in LocalIntegrator.

Author

Guido Kanschat, 2009

Definition at line 433 of file loop.h.