NodeAttributes< SPACE_DIM > Class Template Reference

#include <NodeAttributes.hpp>

Collaboration diagram for NodeAttributes< SPACE_DIM >:

Public Member Functions
	NodeAttributes ()
std::vector< double > &	rGetAttributes ()
void	AddAttribute (double attribute)
unsigned	GetRegion ()
void	SetRegion (unsigned region)
c_vector< double, SPACE_DIM > &	rGetAppliedForce ()
void	AddAppliedForceContribution (c_vector< double, SPACE_DIM > &appliedForceContribution)
void	ClearAppliedForce ()
bool	IsParticle ()
void	SetIsParticle (bool isParticle)
double	GetRadius ()
void	SetRadius (double radius)

Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)

Private Attributes
std::vector< double >	mAttributes
unsigned	mRegion
c_vector< double, SPACE_DIM >	mAppliedForce
double	mRadius
bool	mIsParticle

Friends
class	boost::serialization::access

Detailed Description

template<unsigned SPACE_DIM>
class NodeAttributes< SPACE_DIM >

A container for attributes associated with the Node class.

Definition at line 47 of file NodeAttributes.hpp.

Constructor & Destructor Documentation

template<unsigned SPACE_DIM>

NodeAttributes< SPACE_DIM >::NodeAttributes

(

)

Defaults all variables.

Definition at line 42 of file NodeAttributes.cpp.

Member Function Documentation

template<unsigned SPACE_DIM>

void NodeAttributes< SPACE_DIM >::AddAppliedForceContribution

(

c_vector< double, SPACE_DIM > &

appliedForceContribution

)

Add a contribution to the force vector

Parameters

appliedForceContribution

the contribution to add to mAppliedForce

Definition at line 83 of file NodeAttributes.cpp.

template<unsigned SPACE_DIM>

void NodeAttributes< SPACE_DIM >::AddAttribute

(

double

attribute

)

Push an attribute back onto mAttributes

Parameters

attribute

the value of the attribute.

Definition at line 59 of file NodeAttributes.cpp.

template<unsigned SPACE_DIM>

void NodeAttributes< SPACE_DIM >::ClearAppliedForce

(

)

Set mAppliedForce to a zero vector.

Definition at line 89 of file NodeAttributes.cpp.

template<unsigned SPACE_DIM>

double NodeAttributes< SPACE_DIM >::GetRadius

(

)

Return the radius associated with the Node

Returns

mRadius

Definition at line 110 of file NodeAttributes.cpp.

template<unsigned SPACE_DIM>

unsigned NodeAttributes< SPACE_DIM >::GetRegion

(

)

Get the region ID

Returns

mRegion

Definition at line 65 of file NodeAttributes.cpp.

template<unsigned SPACE_DIM>

bool NodeAttributes< SPACE_DIM >::IsParticle

(

)

Get whether this node is a particle, or not.

Returns

mIsParticle

Definition at line 98 of file NodeAttributes.cpp.

template<unsigned SPACE_DIM>

c_vector< double, SPACE_DIM > & NodeAttributes< SPACE_DIM >::rGetAppliedForce

(

)

Get the current value of the applied force on the node.

Returns

mAppliedForce

Definition at line 77 of file NodeAttributes.cpp.

template<unsigned SPACE_DIM>

std::vector< double > & NodeAttributes< SPACE_DIM >::rGetAttributes

(

)

Returns

mAttributes

Definition at line 53 of file NodeAttributes.cpp.

template<unsigned SPACE_DIM>

template<class Archive >

void NodeAttributes< SPACE_DIM >::serialize ( Archive &  archive, const unsigned int  version  )

inlineprivate

Archive the member variables.

Parameters

archive	the archive
version	the current version of this class

Definition at line 76 of file NodeAttributes.hpp.

References NodeAttributes< SPACE_DIM >::mAppliedForce, NodeAttributes< SPACE_DIM >::mAttributes, NodeAttributes< SPACE_DIM >::mIsParticle, NodeAttributes< SPACE_DIM >::mRadius, and NodeAttributes< SPACE_DIM >::mRegion.

template<unsigned SPACE_DIM>

void NodeAttributes< SPACE_DIM >::SetIsParticle

(

bool

isParticle

)

Set the flag mIsParticle.

Parameters

isParticle

whether this node is particle or not.

Definition at line 104 of file NodeAttributes.cpp.

template<unsigned SPACE_DIM>

void NodeAttributes< SPACE_DIM >::SetRadius

(

double

radius

)

Set the value of the radius.

Parameters

radius

the value to assign to mRadius. Must be >= 0.0

Definition at line 116 of file NodeAttributes.cpp.

References EXCEPTION.

template<unsigned SPACE_DIM>

void NodeAttributes< SPACE_DIM >::SetRegion

(

unsigned

region

)

Set the region ID

Parameters

region

the value to to assign to mRegion.

Definition at line 71 of file NodeAttributes.cpp.

Friends And Related Function Documentation

template<unsigned SPACE_DIM>

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 67 of file NodeAttributes.hpp.

Member Data Documentation

template<unsigned SPACE_DIM>

c_vector<double, SPACE_DIM> NodeAttributes< SPACE_DIM >::mAppliedForce

private

For mutable nodes in OffLatticeSimulations, a container for the force accumulated on this node.

Definition at line 58 of file NodeAttributes.hpp.

Referenced by NodeAttributes< SPACE_DIM >::serialize().

template<unsigned SPACE_DIM>

std::vector<double> NodeAttributes< SPACE_DIM >::mAttributes

private

Arbitrary attributes that a user gives meaning to

Definition at line 52 of file NodeAttributes.hpp.

Referenced by NodeAttributes< SPACE_DIM >::serialize().

template<unsigned SPACE_DIM>

bool NodeAttributes< SPACE_DIM >::mIsParticle

private

Whether the node represents a particle or not: Used for NodeBasedCellPopulationWithParticles

Definition at line 64 of file NodeAttributes.hpp.

Referenced by NodeAttributes< SPACE_DIM >::serialize().

template<unsigned SPACE_DIM>

double NodeAttributes< SPACE_DIM >::mRadius

private

The radius associated with the Node

Definition at line 61 of file NodeAttributes.hpp.

Referenced by NodeAttributes< SPACE_DIM >::serialize().

template<unsigned SPACE_DIM>

unsigned NodeAttributes< SPACE_DIM >::mRegion

private

The ID of the region of mesh in which the Node lies

Definition at line 55 of file NodeAttributes.hpp.

Referenced by NodeAttributes< SPACE_DIM >::serialize().

---

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

• mesh/src/common/NodeAttributes.hpp
• mesh/src/common/NodeAttributes.cpp