Chaste  Build::
DiscreteContinuumBoundaryCondition< DIM > Class Template Reference
+ Collaboration diagram for DiscreteContinuumBoundaryCondition< DIM >:

Public Member Functions

 DiscreteContinuumBoundaryCondition ()
 
virtual ~DiscreteContinuumBoundaryCondition ()
 
BoundaryConditionType::Value GetType ()
 
units::quantity< unit::concentration > GetValue ()
 
void SetNetwork (boost::shared_ptr< VesselNetwork< DIM > > pNetwork)
 
std::pair< bool, units::quantity< unit::concentration > > GetValue (DimensionalChastePoint< DIM > location, double tolerance)
 
void UpdateBoundaryConditionContainer (boost::shared_ptr< BoundaryConditionsContainer< DIM, DIM, 1 > > pContainer)
 
void UpdateRegularGridPointBoundaryConditions (boost::shared_ptr< std::vector< std::pair< bool, units::quantity< unit::concentration > > > >pBoundaryConditions)
 
void UpdateRegularGridFacetBoundaryConditions (boost::shared_ptr< std::vector< std::pair< bool, units::quantity< unit::concentration > > > >pBoundaryConditions)
 
void UpdateRegularGridSegmentBoundaryConditions (boost::shared_ptr< std::vector< std::pair< bool, units::quantity< unit::concentration > > > >pBoundaryConditions)
 
void UpdateRegularGridPartBoundaryConditions (boost::shared_ptr< std::vector< std::pair< bool, units::quantity< unit::concentration > > > >pBoundaryConditions)
 
void UpdateRegularGridCellBoundaryConditions (boost::shared_ptr< std::vector< std::pair< bool, units::quantity< unit::concentration > > > >pBoundaryConditions)
 
void UpdateRegularGridBoundaryConditions (boost::shared_ptr< std::vector< std::pair< bool, units::quantity< unit::concentration > > > > pBoundaryConditions)
 
void SetDomain (boost::shared_ptr< Part< DIM > > pDomain)
 
void SetLabelName (const std::string &label)
 
void SetMesh (boost::shared_ptr< DiscreteContinuumMesh< DIM, DIM > > pMesh)
 
void SetPoints (std::vector< DimensionalChastePoint< DIM > > points)
 
void SetRegularGrid (boost::shared_ptr< RegularGrid< DIM > > pRegularGrid)
 
void SetSource (BoundaryConditionSource::Value boundarySource)
 
void SetType (BoundaryConditionType::Value boundaryType)
 
void SetValue (units::quantity< unit::concentration > value)
 

Static Public Member Functions

static boost::shared_ptr< DiscreteContinuumBoundaryCondition< DIM > > Create ()
 

Protected Attributes

boost::shared_ptr< Part< DIM > > mpDomain
 
std::vector< DimensionalChastePoint< DIM > > mPoints
 
BoundaryConditionType::Value mType
 
BoundaryConditionSource::Value mSource
 
std::string mLabel
 
units::quantity< unit::concentration > mValue
 
boost::shared_ptr< RegularGrid< DIM > > mpRegularGrid
 
boost::shared_ptr< DiscreteContinuumMesh< DIM, DIM > > mpMesh
 
boost::shared_ptr< VesselNetwork< DIM > > mpNetwork
 
units::quantity< unit::concentration > mReferenceConcentration
 

Detailed Description

template<unsigned DIM>
class DiscreteContinuumBoundaryCondition< DIM >

Definition at line 78 of file DiscreteContinuumBoundaryCondition.hpp.

Constructor & Destructor Documentation

Constructor

Definition at line 44 of file DiscreteContinuumBoundaryCondition.cpp.

template<unsigned DIM>
DiscreteContinuumBoundaryCondition< DIM >::~DiscreteContinuumBoundaryCondition ( )
virtual

Destructor

Definition at line 60 of file DiscreteContinuumBoundaryCondition.cpp.

Member Function Documentation

template<unsigned DIM>
boost::shared_ptr< DiscreteContinuumBoundaryCondition< DIM > > DiscreteContinuumBoundaryCondition< DIM >::Create ( )
static

Factory constructor method

Definition at line 72 of file DiscreteContinuumBoundaryCondition.cpp.

template<unsigned DIM>
BoundaryConditionType::Value DiscreteContinuumBoundaryCondition< DIM >::GetType ( )

Return the type of boundary condition, POINT, FACET, OUTER etc.

Returns
the type of boundary condition

Definition at line 85 of file DiscreteContinuumBoundaryCondition.cpp.

References DiscreteContinuumBoundaryCondition< DIM >::mType.

template<unsigned DIM>
units::quantity< unit::concentration > DiscreteContinuumBoundaryCondition< DIM >::GetValue ( )

Return the default value of the boundary condition

Returns
the default value of the boundary condition

Definition at line 79 of file DiscreteContinuumBoundaryCondition.cpp.

References DiscreteContinuumBoundaryCondition< DIM >::mValue.

Referenced by DiscreteContinuumBoundaryCondition< DIM >::UpdateBoundaryConditionContainer().

template<unsigned DIM>
std::pair< bool, units::quantity< unit::concentration > > DiscreteContinuumBoundaryCondition< DIM >::GetValue ( DimensionalChastePoint< DIM >  location,
double  tolerance 
)

Return the value of the boundary condition evaluated at a point and whether the point is on a boundary

Parameters
locationthe location of the point
tolerancethe tolerance for evaluating if a point is on a boundary
Returns
a bool specifying if the point is on a boundary and the value of the point on the boundary

Definition at line 182 of file DiscreteContinuumBoundaryCondition.cpp.

References DimensionalChastePoint< DIM >::GetReferenceLengthScale(), DiscreteContinuumBoundaryCondition< DIM >::mLabel, DiscreteContinuumBoundaryCondition< DIM >::mpDomain, DiscreteContinuumBoundaryCondition< DIM >::mPoints, DiscreteContinuumBoundaryCondition< DIM >::mpRegularGrid, DiscreteContinuumBoundaryCondition< DIM >::mType, and DiscreteContinuumBoundaryCondition< DIM >::mValue.

template<unsigned DIM>
void DiscreteContinuumBoundaryCondition< DIM >::SetDomain ( boost::shared_ptr< Part< DIM > >  pDomain)

Set a domain for use in the calculation of FACET type boundary conditions

Parameters
pDomainthe part containing labelled facets for the boundary condition

Definition at line 444 of file DiscreteContinuumBoundaryCondition.cpp.

References DiscreteContinuumBoundaryCondition< DIM >::mpDomain.

template<unsigned DIM>
void DiscreteContinuumBoundaryCondition< DIM >::SetLabelName ( const std::string &  label)

Set the name of the label used in LABEL type sources

Parameters
rLabelthe label for the source strength value

Definition at line 480 of file DiscreteContinuumBoundaryCondition.cpp.

References DiscreteContinuumBoundaryCondition< DIM >::mLabel.

template<unsigned DIM>
void DiscreteContinuumBoundaryCondition< DIM >::SetMesh ( boost::shared_ptr< DiscreteContinuumMesh< DIM, DIM > >  pMesh)

Set the finite element mesh

Parameters
pMeshthe finite element mesh

Definition at line 474 of file DiscreteContinuumBoundaryCondition.cpp.

References DiscreteContinuumBoundaryCondition< DIM >::mpMesh.

template<unsigned DIM>
void DiscreteContinuumBoundaryCondition< DIM >::SetPoints ( std::vector< DimensionalChastePoint< DIM > >  points)

Set the points for POINT type boundary conditions

Parameters
pointsthe point locations for POINT type boundary conditions

Definition at line 450 of file DiscreteContinuumBoundaryCondition.cpp.

References DiscreteContinuumBoundaryCondition< DIM >::mPoints.

template<unsigned DIM>
void DiscreteContinuumBoundaryCondition< DIM >::SetRegularGrid ( boost::shared_ptr< RegularGrid< DIM > >  pRegularGrid)

Set the regular grid

Parameters
pRegularGridthe regular grid

Definition at line 468 of file DiscreteContinuumBoundaryCondition.cpp.

References DiscreteContinuumBoundaryCondition< DIM >::mpRegularGrid.

template<unsigned DIM>
void DiscreteContinuumBoundaryCondition< DIM >::SetSource ( BoundaryConditionSource::Value  boundarySource)

Set where the value of the boundary condition is obtained, e.g. LABEL, PRESCRIBED

Parameters
boundarySourceenum specifying where the value of the boundary condition is obtained

Definition at line 456 of file DiscreteContinuumBoundaryCondition.cpp.

References DiscreteContinuumBoundaryCondition< DIM >::mSource.

template<unsigned DIM>
void DiscreteContinuumBoundaryCondition< DIM >::SetType ( BoundaryConditionType::Value  boundaryType)

Set the type of boundary condition, e.g. POINT, FACET

Parameters
boundaryTypeenum specifying the type of boundary condition

Definition at line 462 of file DiscreteContinuumBoundaryCondition.cpp.

References DiscreteContinuumBoundaryCondition< DIM >::mType.

template<unsigned DIM>
void DiscreteContinuumBoundaryCondition< DIM >::SetValue ( units::quantity< unit::concentration >  value)

Set the default value of the boundary condition for any points on the boundary

Parameters
valuethe default value of the boundary condition for any points on the boundary

Definition at line 486 of file DiscreteContinuumBoundaryCondition.cpp.

References DiscreteContinuumBoundaryCondition< DIM >::mValue.

template<unsigned DIM>
void DiscreteContinuumBoundaryCondition< DIM >::UpdateBoundaryConditionContainer ( boost::shared_ptr< BoundaryConditionsContainer< DIM, DIM, 1 > >  pContainer)
template<unsigned DIM>
void DiscreteContinuumBoundaryCondition< DIM >::UpdateRegularGridBoundaryConditions ( boost::shared_ptr< std::vector< std::pair< bool, units::quantity< unit::concentration > > > >  pBoundaryConditions)

Update the boundary conditions on the regular grid

Parameters
pBoundaryConditionsthe boundary condition container
tolerancethe tolerance for evaluating if a point is on a boundary

Definition at line 406 of file DiscreteContinuumBoundaryCondition.cpp.

References DiscreteContinuumBoundaryCondition< DIM >::mpRegularGrid, DiscreteContinuumBoundaryCondition< DIM >::mType, and DiscreteContinuumBoundaryCondition< DIM >::mValue.

Member Data Documentation

template<unsigned DIM>
std::string DiscreteContinuumBoundaryCondition< DIM >::mLabel
protected

A label specifying the array name from which to obtain the condition magnitude. Used for LABEL conditions.

Definition at line 107 of file DiscreteContinuumBoundaryCondition.hpp.

Referenced by DiscreteContinuumBoundaryCondition< DIM >::GetValue(), and DiscreteContinuumBoundaryCondition< DIM >::SetLabelName().

template<unsigned DIM>
boost::shared_ptr<Part<DIM> > DiscreteContinuumBoundaryCondition< DIM >::mpDomain
protected
template<unsigned DIM>
boost::shared_ptr<DiscreteContinuumMesh<DIM, DIM> > DiscreteContinuumBoundaryCondition< DIM >::mpMesh
protected
template<unsigned DIM>
std::vector<DimensionalChastePoint<DIM> > DiscreteContinuumBoundaryCondition< DIM >::mPoints
protected
template<unsigned DIM>
BoundaryConditionSource::Value DiscreteContinuumBoundaryCondition< DIM >::mSource
protected

Where the boundary condition value is obtained from

Definition at line 101 of file DiscreteContinuumBoundaryCondition.hpp.

Referenced by DiscreteContinuumBoundaryCondition< DIM >::SetSource().


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