Detailed Description

template<class T>
class gismo::gsBoundaryConditions< T >

Class containing a set of boundary conditions.

The boundary conditions are stored in the form of a list of boundary_condition instances.

Collaboration diagram for gsBoundaryConditions< T >:

Public Member Functions
void	addCondition (int p, boxSide s, condition_type::type t, gsFunctionSet< T > *f, short_t unknown=0, bool parametric=false, int comp=-1)
	Adds another boundary condition.

void	addCornerValue (boundary::corner c, T value, int p=0, short_t unknown=0, int component=-1)
	Adds a boundary condition with value on a corner c of patch p for unknown component.

void	addCornerValue (boxCorner c, T value, int p=0, short_t unknown=0, int component=-1)
	Adds a boundary condition with value on a corner c of patch p for unknown component.

void	addCoupled (int p1, boundary::side s1, int p2, boundary::side s2, index_t dim, short_t unknown=0, int comp=-1)
	Couples the degrees of freedom on patch p1 side s1 and patch p2 side s2 for unknown and component comp.

void	addCoupled (int p1, boxSide s1, int p2, boxSide s2, index_t dim, short_t unknown=0, int comp=-1)
	Couples the degrees of freedom on patch p1 side s1 and patch p2 side s2 for unknown and component comp.

void	addPeriodic (int p1, boxSide s1, int p2, boxSide s2, short_t dim)
	Add a periodic condition between side s1 of box p1 and side s2 of box p2.

iterator	begin (const std::string &label)
	Returns an iterator to the beginning of the Bc container of type label.

const_iterator	begin (const std::string &label) const
	Returns a const-iterator to the beginning of the Bc container of type label.

void	clearPeriodicPairs ()
	Removes all periodic pairs.

const bcContainer &	container (const std::string &label) const
	Return a reference to boundary conditions of certain type.

citerator	cornerBegin ()

const_citerator	cornerBegin () const

citerator	cornerEnd ()

const_citerator	cornerEnd () const

cpliterator	coupledBegin ()

const_cpliterator	coupledBegin () const

cpliterator	coupledEnd ()

const_cpliterator	coupledEnd () const

iterator	dirichletBegin ()

const_iterator	dirichletBegin () const

iterator	dirichletEnd ()

const_iterator	dirichletEnd () const

const bcContainer &	dirichletSides () const
	Return a reference to the Dirichlet sides.

iterator	end (const std::string &label)
	Returns an iterator to the end of the Bc container of type label.

const_iterator	end (const std::string &label) const
	Returns a const-iterator to the end of the Bc container of type label.

const gsFunctionSet< T > &	geoMap () const
	Returns the geometry map.

bcRefList	get (const std::string &label, const short_t unk=0, int comp=-1) const

const boundary_condition< T > *	getConditionFromSide (patchSide ps) const
	getSideCondition

void	getConditionFromSide (patchSide ps, bcContainer &result) const
	getConditionFromSide returns the boundary conditions associated to the given patch side

void	getConditionsForPatch (const index_t np, gsBoundaryConditions &result) const
	returns the set of all boundary conditions which refer to patch np

gsMatrix< T >	getTransformMatrix () const
	Get transformation matrix for the periodic pairs of sides.

bool	hasGeoMap () const
	Checks if a geometry map is stored in the boundary conditions.

iterator	neumannBegin ()

const_iterator	neumannBegin () const

iterator	neumannEnd ()

const_iterator	neumannEnd () const

const bcContainer &	neumannSides () const
	Return a reference to the Neumann sides.

size_t	numPeriodic () const
	Get number of periodic pairs.

ppiterator	periodicBegin ()

const_ppiterator	periodicBegin () const

ppiterator	periodicEnd ()

const_ppiterator	periodicEnd () const

const ppContainer &	periodicPairs () const
	Return a reference to the periodic sides.

std::ostream &	print (std::ostream &os, const bool verbose=false) const
	Prints the object as a string.

bcContainer	reducedContainer (const bcContainer &container, short_t unknown) const
	Extracts the BC, comming from a certain component.

iterator	robinBegin ()

const_iterator	robinBegin () const

iterator	robinEnd ()

const_iterator	robinEnd () const

const bcContainer &	robinSides () const
	Return a reference to the Robin sides.

void	setGeoMap (const gsFunctionSet< T > &gm)
	Set the geometry map to evaluate boundary conditions.

void	setIdentityMatrix (short_t dim)
	Set identity transformation matrix for the periodic pairs of sides.

void	setTransformMatrix (gsMatrix< T > trMatrix)
	Set transformation matrix for the periodic pairs of sides.

iterator	weakDirichletBegin ()

const_iterator	weakDirichletBegin () const

iterator	weakDirichletEnd ()

const_iterator	weakDirichletEnd () const

const bcContainer &	weakDirichletSides () const
	Return a reference to the Weak Dirichlet sides.

Private Attributes
cornerContainer	corner_values
	List of corners with fixed value.

cplContainer	coupled_boundaries
	List of boundaries that are coupled.

bcData	m_bc
	Containers for BCs of various types.

Member Function Documentation

◆ addCondition()

template<class T >

void addCondition	(	int	p,
		boxSide	s,
		condition_type::type	t,
		gsFunctionSet< T > *	f,
		short_t	unknown = `0`,
		bool	parametric = `false`,
		int	comp = `-1`
	)

inline

Adds another boundary condition.

Creates an object of type boundary_condition and adds is to the list of corresponding boundary conditions.

Parameters

p	Index of the patch
s	Side of the patch
t	Type of boundary condition (see condition_type::type)
f	Function defining the boundary condition
unknown	Specifies which unknown variable the boundary condition refers to (to be used if more than one variable is unknown, e.g., velocity and pressure)
parametric	True if the function data for this boundary condition is defined in parametric coordinates.

◆ cornerBegin() [1/2]

template<class T >

citerator cornerBegin ( )

inline

Get an iterator to the beginning of the corner values

Returns: an iterator to the beginning of the corner values

◆ cornerBegin() [2/2]

template<class T >

const_citerator cornerBegin ( ) const

inline

Get an iterator to the beginning of the corner values

Returns: an iterator to the beginning of the corner values

◆ cornerEnd() [1/2]

template<class T >

citerator cornerEnd ( )

inline

Get an iterator to the end of corner values

Returns: an iterator to the end of the corner values

◆ cornerEnd() [2/2]

template<class T >

const_citerator cornerEnd ( ) const

inline

Get an iterator to the end of corner values

Returns: an iterator to the end of the corner values

◆ coupledBegin() [1/2]

template<class T >

cpliterator coupledBegin ( )

inline

Get an iterator to the beginning of the coupled boundaries

Returns: an iterator to the beginning of the coupled boundaries

◆ coupledBegin() [2/2]

template<class T >

const_cpliterator coupledBegin ( ) const

inline

Get an iterator to the beginning of the coupled boundaries

Returns: an iterator to the beginning of the coupled boundaries

◆ coupledEnd() [1/2]

template<class T >

cpliterator coupledEnd ( )

inline

Get an iterator to the end of coupled boundaries

Returns: an iterator to the end of the coupled boundaries

◆ coupledEnd() [2/2]

template<class T >

const_cpliterator coupledEnd ( ) const

inline

Get an iterator to the end of coupled boundaries

Returns: an iterator to the end of the coupled boundaries

◆ dirichletBegin() [1/2]

template<class T >

iterator dirichletBegin ( )

inline

Get an iterator to the beginning of the Dirichlet sides

Returns: an iterator to the beginning of the Dirichlet sides

◆ dirichletBegin() [2/2]

template<class T >

const_iterator dirichletBegin ( ) const

inline

Get a const-iterator to the beginning of the Dirichlet sides

Returns: an iterator to the beginning of the Dirichlet sides

◆ dirichletEnd() [1/2]

template<class T >

iterator dirichletEnd ( )

inline

Get an iterator to the end of the Dirichlet sides

Returns: an iterator to the end of the Dirichlet sides

◆ dirichletEnd() [2/2]

template<class T >

const_iterator dirichletEnd ( ) const

inline

Get a const-iterator to the end of the Dirichlet sides

Returns: an iterator to the end of the Dirichlet sides

◆ get()

template<class T >

bcRefList get	(	const std::string &	label,
		const short_t	unk = `0`,
		int	comp = `-1`
	)		const

inline

Return a reference to boundary conditions of certain type for unknown unk

◆ getConditionFromSide() [1/2]

template<class T >

const boundary_condition< T > * getConditionFromSide ( patchSide ps ) const

inline

getSideCondition

Parameters

ps	the patch side

Returns: the boundary condition associated to ps or NULL if no condition is associated to ps

It is the task of the user of this function to check if the returned pointer is NULL.

Do not use this function if you want to apply boundary conditions during matrix assembly. Instead, iterate over all conditions of the type you need (eg. Neumann, Dirichlet)

◆ getConditionFromSide() [2/2]

template<class T >

void getConditionFromSide	(	patchSide	ps,
		bcContainer &	result
	)		const

inline

getConditionFromSide returns the boundary conditions associated to the given patch side

Parameters

[in]	ps	patch side
[out]	result	bcContainer containing the boundary conditions associated to ps

◆ getConditionsForPatch()

template<class T >

void getConditionsForPatch	(	const index_t	np,
		gsBoundaryConditions< T > &	result
	)		const

inline

returns the set of all boundary conditions which refer to patch np

Parameters

[in]	np	the patch index
[out]	result	the new set of boundary conditions

◆ neumannBegin() [1/2]

template<class T >

iterator neumannBegin ( )

inline

Get an iterator to the beginning of the Neumann sides

Returns: an iterator to the beginning of the Neumann sides

◆ neumannBegin() [2/2]

template<class T >

const_iterator neumannBegin ( ) const

inline

Get a const-iterator to the beginning of the Neumann sides

Returns: an iterator to the beginning of the Neumann sides

◆ neumannEnd() [1/2]

template<class T >

iterator neumannEnd ( )

inline

Get an iterator to the end of the Neumann sides

Returns: an iterator to the end of the Neumann sides

◆ neumannEnd() [2/2]

template<class T >

const_iterator neumannEnd ( ) const

inline

Get a const-iterator to the end of the Neumann sides

Returns: an iterator to the end of the Neumann sides

◆ periodicBegin() [1/2]

template<class T >

ppiterator periodicBegin ( )

inline

Get an iterator to the beginning of the periodic sides

Returns: an iterator to the beginning of the periodic sides

◆ periodicBegin() [2/2]

template<class T >

const_ppiterator periodicBegin ( ) const

inline

Get a const-iterator to the beginning of the periodic sides

Returns: an iterator to the beginning of the periodic sides

◆ periodicEnd() [1/2]

template<class T >

ppiterator periodicEnd ( )

inline

Get an iterator to the end of the periodic sides

Returns: an iterator to the end of the periodic sides

◆ periodicEnd() [2/2]

template<class T >

const_ppiterator periodicEnd ( ) const

inline

Get a const-iterator to the end of the periodic sides

Returns: an iterator to the end of the periodic sides

◆ robinBegin() [1/2]

template<class T >

iterator robinBegin ( )

inline

Get an iterator to the beginning of the Robin sides

Returns: an iterator to the beginning of the Robin sides

◆ robinBegin() [2/2]

template<class T >

const_iterator robinBegin ( ) const

inline

Get a const-iterator to the beginning of the Robin sides

Returns: an iterator to the beginning of the Robin sides

◆ robinEnd() [1/2]

template<class T >

iterator robinEnd ( )

inline

Get an iterator to the end of the Robin sides

Returns: an iterator to the end of the Robin sides

◆ robinEnd() [2/2]

template<class T >

const_iterator robinEnd ( ) const

inline

Get a const-iterator to the end of the Robin sides

Returns: an iterator to the end of the Robin sides

◆ weakDirichletBegin() [1/2]

template<class T >

iterator weakDirichletBegin ( )

inline

Get an iterator to the beginning of the Weak Dirichlet sides

Returns: an iterator to the beginning of the Weak Dirichlet sides

◆ weakDirichletBegin() [2/2]

template<class T >

const_iterator weakDirichletBegin ( ) const

inline

Get a const-iterator to the beginning of the Weak Dirichlet sides

Returns: an iterator to the beginning of the Weak Dirichlet sides

◆ weakDirichletEnd() [1/2]

template<class T >

iterator weakDirichletEnd ( )

inline

Get an iterator to the end of the Weak Dirichlet sides

Returns: an iterator to the end of the Weak Dirichlet sides

◆ weakDirichletEnd() [2/2]

template<class T >

const_iterator weakDirichletEnd ( ) const

inline

Get a const-iterator to the end of the Weak Dirichlet sides

Returns: an iterator to the end of the Weak Dirichlet sides

Detailed Description

Public Member Functions

Private Attributes

Member Function Documentation

◆ addCondition()

◆ cornerBegin() [1/2]

◆ cornerBegin() [2/2]

◆ cornerEnd() [1/2]

◆ cornerEnd() [2/2]

◆ coupledBegin() [1/2]

◆ coupledBegin() [2/2]

◆ coupledEnd() [1/2]

◆ coupledEnd() [2/2]

◆ dirichletBegin() [1/2]

◆ dirichletBegin() [2/2]

◆ dirichletEnd() [1/2]

◆ dirichletEnd() [2/2]

◆ get()

◆ getConditionFromSide() [1/2]

◆ getConditionFromSide() [2/2]

◆ getConditionsForPatch()

◆ neumannBegin() [1/2]

◆ neumannBegin() [2/2]

◆ neumannEnd() [1/2]

◆ neumannEnd() [2/2]

◆ periodicBegin() [1/2]

◆ periodicBegin() [2/2]

◆ periodicEnd() [1/2]

◆ periodicEnd() [2/2]

◆ robinBegin() [1/2]

◆ robinBegin() [2/2]

◆ robinEnd() [1/2]

◆ robinEnd() [2/2]

◆ weakDirichletBegin() [1/2]

◆ weakDirichletBegin() [2/2]

◆ weakDirichletEnd() [1/2]

◆ weakDirichletEnd() [2/2]