dune-fem 2.8.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
Dune::Fem::LocalMatrixInterface< LocalMatrixTraits > Class Template Reference

Interface for local matrix classes. More...

#include <dune/fem/operator/common/localmatrix.hh>

Inheritance diagram for Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >:
Inheritance graph

Public Types

typedef LocalMatrixTraits Traits
 type of traits class
 
typedef ThisType LocalMatrixInterfaceType
 type of this interface
 
typedef Traits::LocalMatrixType LocalMatrixType
 type of local matrix implementation
 
typedef Traits::RangeFieldType RangeFieldType
 type of range field
 
typedef Traits::DomainSpaceType DomainSpaceType
 type of domain discrete function space
 
typedef Traits::RangeSpaceType RangeSpaceType
 type of range discrete function space
 
typedef DomainSpaceType::BasisFunctionSetType DomainBasisFunctionSetType
 type of base function sets within domain function space
 
typedef RangeSpaceType::BasisFunctionSetType RangeBasisFunctionSetType
 type of base function sets within range function space
 
typedef DomainSpaceType::EntityType DomainEntityType
 
typedef RangeSpaceType::EntityType RangeEntityType
 
typedef Traits::LittleBlockType LittleBlockType
 
typedef MatrixColumnObject< TraitsMatrixColumnType
 

Public Member Functions

void init (const DomainEntityType &domainEntity, const RangeEntityType &rangeEntity)
 initialize the local matrix to entities
 
void bind (const DomainEntityType &domainEntity, const RangeEntityType &rangeEntity)
 initialize the local matrix to entities
 
void unbind ()
 clear local matrix from entities
 
void add (const int localRow, const int localCol, const RangeFieldType &value)
 add value to matrix entry (row,col) where row and col are local row and local column
 
void set (const int localRow, const int localCol, const RangeFieldType &value)
 set value of matrix entry (row,col) where row and col are local row and local column
 
void clearRow (const int localRow)
 set row to zero values
 
void clearCol (const int localCol)
 ser column entries to zero
 
template<class DomainLocalFunctionType , class RangeLocalFunctionType >
void multiplyAdd (const DomainLocalFunctionType &lhs, RangeLocalFunctionType &rhs) const
 multiply left hand side with local matrix and add to right hand side rhs += Matrix * lhs
 
const RangeFieldType get (const int localRow, const int localCol) const
 get value of matrix entry (row,col) where row and col are local row and local column
 
void scale (const RangeFieldType &scalar)
 scale matrix with scalar value
 
void clear ()
 set all entries of local matrix to zero
 
void resort ()
 resort ordering in global matrix (if possible)
 
int rows () const
 get number of rows within the matrix
 
int columns () const
 get number of columns within the matrix
 
const DomainSpaceTypedomainSpace () const
 access to the domain space
 
const RangeSpaceTyperangeSpace () const
 access to the range space
 
const DomainBasisFunctionSetTypedomainBasisFunctionSet () const
 access to the base function set within the domain space
 
const RangeBasisFunctionSetTyperangeBasisFunctionSet () const
 access to the base function set within the range space
 
const DomainEntityTypedomainEntity () const
 
const RangeEntityTyperangeEntity () const
 
MatrixColumnType column (const unsigned int col)
 return column object for local matrix which contains axpy methods for convenience
 
void finalize ()
 finalize local matrix setup and possibly add values to real matrix
 

Protected Member Functions

 LocalMatrixInterface ()
 constructor
 
const Implementation & asImp () const
 
Implementation & asImp ()
 

Static Protected Member Functions

static const Implementation & asImp (const ThisType &other)
 
static Implementation & asImp (ThisType &other)
 
static const LocalMatrixTraits::LocalMatrixType & asImp (const ThisType &other)
 
static LocalMatrixTraits::LocalMatrixType & asImp (ThisType &other)
 

Detailed Description

template<class LocalMatrixTraits>
class Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >

Interface for local matrix classes.

Member Typedef Documentation

◆ DomainBasisFunctionSetType

template<class LocalMatrixTraits >
typedef DomainSpaceType::BasisFunctionSetType Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::DomainBasisFunctionSetType

type of base function sets within domain function space

◆ DomainEntityType

template<class LocalMatrixTraits >
typedef DomainSpaceType::EntityType Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::DomainEntityType

◆ DomainSpaceType

template<class LocalMatrixTraits >
typedef Traits::DomainSpaceType Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::DomainSpaceType

type of domain discrete function space

◆ LittleBlockType

template<class LocalMatrixTraits >
typedef Traits::LittleBlockType Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::LittleBlockType

type of block (i.e. FieldMatrix for BlockMatrices

◆ LocalMatrixInterfaceType

template<class LocalMatrixTraits >
typedef ThisType Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::LocalMatrixInterfaceType

type of this interface

◆ LocalMatrixType

template<class LocalMatrixTraits >
typedef Traits::LocalMatrixType Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::LocalMatrixType

type of local matrix implementation

◆ MatrixColumnType

template<class LocalMatrixTraits >
typedef MatrixColumnObject< Traits > Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::MatrixColumnType

◆ RangeBasisFunctionSetType

template<class LocalMatrixTraits >
typedef RangeSpaceType::BasisFunctionSetType Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::RangeBasisFunctionSetType

type of base function sets within range function space

◆ RangeEntityType

template<class LocalMatrixTraits >
typedef RangeSpaceType::EntityType Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::RangeEntityType

◆ RangeFieldType

template<class LocalMatrixTraits >
typedef Traits::RangeFieldType Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::RangeFieldType

type of range field

◆ RangeSpaceType

template<class LocalMatrixTraits >
typedef Traits::RangeSpaceType Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::RangeSpaceType

type of range discrete function space

◆ Traits

template<class LocalMatrixTraits >
typedef LocalMatrixTraits Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::Traits

type of traits class

Constructor & Destructor Documentation

◆ LocalMatrixInterface()

template<class LocalMatrixTraits >
Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::LocalMatrixInterface ( )
inlineprotected

constructor

Member Function Documentation

◆ add()

template<class LocalMatrixTraits >
void Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::add ( const int  localRow,
const int  localCol,
const RangeFieldType value 
)
inline

add value to matrix entry (row,col) where row and col are local row and local column

Parameters
[in]localRowlocal row
[in]localCollocal column
[in]valuevalue to add

◆ asImp() [1/6]

template<class LocalMatrixTraits >
Implementation & Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp ( )
inlineprotected

◆ asImp() [2/6]

template<class LocalMatrixTraits >
const Implementation & Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp ( ) const
inlineprotected

◆ asImp() [3/6]

static const LocalMatrixTraits::LocalMatrixType & Dune::Fem::BartonNackmanInterface< LocalMatrixInterface< LocalMatrixTraits > , LocalMatrixTraits::LocalMatrixType >::asImp ( const ThisType other)
inlinestaticprotectedinherited

◆ asImp() [4/6]

template<class LocalMatrixTraits >
static const Implementation & Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp ( const ThisType other)
inlinestaticprotected

◆ asImp() [5/6]

static LocalMatrixTraits::LocalMatrixType & Dune::Fem::BartonNackmanInterface< LocalMatrixInterface< LocalMatrixTraits > , LocalMatrixTraits::LocalMatrixType >::asImp ( ThisType other)
inlinestaticprotectedinherited

◆ asImp() [6/6]

template<class LocalMatrixTraits >
static Implementation & Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp ( ThisType other)
inlinestaticprotected

◆ bind()

template<class LocalMatrixTraits >
void Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::bind ( const DomainEntityType domainEntity,
const RangeEntityType rangeEntity 
)
inline

initialize the local matrix to entities

Parameters
[in]domainEntityentity within grid of domain space,
[in]rangeEntityentity within grid of range space

◆ clear()

template<class LocalMatrixTraits >
void Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::clear ( )
inline

set all entries of local matrix to zero

◆ clearCol()

template<class LocalMatrixTraits >
void Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::clearCol ( const int  localCol)
inline

ser column entries to zero

Parameters
[in]localCollocal column that is set to zero

◆ clearRow()

template<class LocalMatrixTraits >
void Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::clearRow ( const int  localRow)
inline

set row to zero values

Parameters
[in]localRowlocal row that is set to zero

◆ column()

template<class LocalMatrixTraits >
MatrixColumnType Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::column ( const unsigned int  col)
inline

return column object for local matrix which contains axpy methods for convenience

Parameters
collocal column number
Returns
object of type MatrixColumnObject

◆ columns()

template<class LocalMatrixTraits >
int Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::columns ( ) const
inline

get number of columns within the matrix

◆ domainBasisFunctionSet()

template<class LocalMatrixTraits >
const DomainBasisFunctionSetType & Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::domainBasisFunctionSet ( ) const
inline

access to the base function set within the domain space

◆ domainEntity()

template<class LocalMatrixTraits >
const DomainEntityType & Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::domainEntity ( ) const
inline

◆ domainSpace()

template<class LocalMatrixTraits >
const DomainSpaceType & Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::domainSpace ( ) const
inline

access to the domain space

◆ finalize()

template<class LocalMatrixTraits >
void Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::finalize ( )
inline

finalize local matrix setup and possibly add values to real matrix

◆ get()

template<class LocalMatrixTraits >
const RangeFieldType Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::get ( const int  localRow,
const int  localCol 
) const
inline

get value of matrix entry (row,col) where row and col are local row and local column

Parameters
[in]localRowlocal row
[in]localCollocal column
Returns
value of matrix entry

◆ init()

template<class LocalMatrixTraits >
void Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::init ( const DomainEntityType domainEntity,
const RangeEntityType rangeEntity 
)
inline

initialize the local matrix to entities

Parameters
[in]domainEntityentity within grid of domain space,
[in]rangeEntityentity within grid of range space

◆ multiplyAdd()

template<class LocalMatrixTraits >
template<class DomainLocalFunctionType , class RangeLocalFunctionType >
void Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::multiplyAdd ( const DomainLocalFunctionType &  lhs,
RangeLocalFunctionType &  rhs 
) const
inline

multiply left hand side with local matrix and add to right hand side rhs += Matrix * lhs

Parameters
[in]lhsleft hand side
[out]rhsright hand side

◆ rangeBasisFunctionSet()

template<class LocalMatrixTraits >
const RangeBasisFunctionSetType & Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::rangeBasisFunctionSet ( ) const
inline

access to the base function set within the range space

◆ rangeEntity()

template<class LocalMatrixTraits >
const RangeEntityType & Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::rangeEntity ( ) const
inline

◆ rangeSpace()

template<class LocalMatrixTraits >
const RangeSpaceType & Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::rangeSpace ( ) const
inline

access to the range space

◆ resort()

template<class LocalMatrixTraits >
void Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::resort ( )
inline

resort ordering in global matrix (if possible)

◆ rows()

template<class LocalMatrixTraits >
int Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::rows ( ) const
inline

get number of rows within the matrix

◆ scale()

template<class LocalMatrixTraits >
void Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::scale ( const RangeFieldType scalar)
inline

scale matrix with scalar value

Parameters
[in]scalarscalar value that scales the matrix

◆ set()

template<class LocalMatrixTraits >
void Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::set ( const int  localRow,
const int  localCol,
const RangeFieldType value 
)
inline

set value of matrix entry (row,col) where row and col are local row and local column

Parameters
[in]localRowlocal row
[in]localCollocal column
[in]valuevalue to set

◆ unbind()

template<class LocalMatrixTraits >
void Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::unbind ( )
inline

clear local matrix from entities


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