coupling::filtering::FilterInterface< dim > Class Template Reference

#include <FilterInterface.h>

Inheritance diagram for coupling::filtering::FilterInterface< dim >:

Classes
struct	ScalarAccessFunctionPair
struct	VectorAccessFunctionPair

Public Types
using	CellIndex_T

Public Member Functions
	FilterInterface (const std::vector< coupling::datastructures::CouplingCell< dim > * > &inputCellVector, const std::vector< coupling::datastructures::CouplingCell< dim > * > &outputCellVector, const std::array< bool, 7 > filteredValues, const char *type)
	FilterInterface (const char *type)
virtual void	operator() ()=0
void	updateCellData (const std::vector< coupling::datastructures::CouplingCell< dim > * > &new_inputCells, const std::vector< coupling::datastructures::CouplingCell< dim > * > &new_outputCells)
const char *	getType () const
std::vector< coupling::datastructures::CouplingCell< dim > * >	getInputCells () const
std::vector< coupling::datastructures::CouplingCell< dim > * >	getOutputCells () const
coupling::datastructures::CouplingCell< dim > *	getInputCellOfIndex (const CellIndex_T &index)
coupling::datastructures::CouplingCell< dim > *	getOutputCellOfIndex (const CellIndex_T &index)
void	setInputCells (const std::vector< coupling::datastructures::CouplingCell< dim > * > &newInputCells)
int	getSize () const

Protected Attributes
std::vector< coupling::datastructures::CouplingCell< dim > * >	_inputCells
std::vector< coupling::datastructures::CouplingCell< dim > * >	_outputCells
std::vector< ScalarAccessFunctionPair >	_scalarAccessFunctionPairs
std::vector< VectorAccessFunctionPair >	_vectorAccessFunctionPairs
const char *	_type

Detailed Description

template<unsigned int dim>
class coupling::filtering::FilterInterface< dim >

Generic interface for filters that are to be applied to coupling::CellContainer before MD to Macro transfer. Implementations can be found in coupling/filtering/filters.

If you wish to use a filter that does not alter its input data, i.e that is read-only, you want to use coupling::FilterInterfaceReadOnly<dim> instead (as provided in header file coupling/filtering/FilterPipelineReadOnly.h). Examples for such filters are WriteToFile or Strouhal (in coupling/filtering/filters).

Author

Felix Maurer

Member Typedef Documentation

CellIndex_T

template<unsigned int dim>

using coupling::filtering::FilterInterface< dim >::CellIndex_T

Initial value:

 coupling::indexing::CellIndex<dim, coupling::indexing::IndexTrait::local, coupling::indexing::IndexTrait::md2macro,
                                                    coupling::indexing::IndexTrait::noGhost>

Member Data Documentation

_inputCells

template<unsigned int dim>

std::vector<coupling::datastructures::CouplingCell<dim>*> coupling::filtering::FilterInterface< dim >::_inputCells

protected

Filters should read from input vector and write to output vector. Both vectors use the same indexing by default. All unmodified cells of the output vector are implicitly copied from their respective input counterpart, i.e it is not mandatory to have any output.

---

The documentation for this class was generated from the following file:

• coupling/filtering/interfaces/FilterInterface.h