#include <AbstractImmersedBoundaryForce.hpp>

Inheritance diagram for AbstractImmersedBoundaryForce< DIM >:

Collaboration diagram for AbstractImmersedBoundaryForce< DIM >:

Public Member Functions
	AbstractImmersedBoundaryForce ()

virtual	~AbstractImmersedBoundaryForce ()

virtual void	AddImmersedBoundaryForceContribution (std::vector< std::pair< Node< DIM > , Node< DIM > > > &rNodePairs, ImmersedBoundaryCellPopulation< DIM > &rCellPopulation)=0

virtual void	OutputImmersedBoundaryForceParameters (out_stream &rParamsFile)=0

bool	GetAdditiveNormalNoise () const

void	SetAdditiveNormalNoise (bool additiveNormalNoise)

double	GetNormalNoiseMean () const

void	SetNormalNoiseMean (double normalNoiseMean)

double	GetNormalNoiseStdDev () const

void	SetNormalNoiseStdDev (double normalNoiseStdDev)

Public Member Functions inherited from Identifiable
virtual	~Identifiable ()

std::string	GetIdentifier () const

Protected Member Functions
void	AddNormalNoiseToNodes (ImmersedBoundaryCellPopulation< DIM > &rCellPopulation)

Protected Attributes
bool	mAdditiveNormalNoise

double	mNormalNoiseMean

double	mNormalNoiseStdDev

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

Friends
class	boost::serialization::access

Detailed Description

template<unsigned DIM>
class AbstractImmersedBoundaryForce< DIM >

An abstract immersed boundary force class, for use in immersed boundary cell-based simulations.

NOTE: while this class shares similarities with AbstractForce, it is not passed to a simulation object, but instead to an ImmersedBoundarySimulationModifier as all actual immersed boundary logic is handled by the modifer, rather than the typical simulation infrastructure.

Definition at line 56 of file AbstractImmersedBoundaryForce.hpp.

Constructor & Destructor Documentation

◆ AbstractImmersedBoundaryForce()

template<unsigned DIM>

AbstractImmersedBoundaryForce< DIM >::AbstractImmersedBoundaryForce ( )

Default constructor.

Definition at line 41 of file AbstractImmersedBoundaryForce.cpp.

◆ ~AbstractImmersedBoundaryForce()

template<unsigned DIM>

AbstractImmersedBoundaryForce< DIM >::~AbstractImmersedBoundaryForce ( )

virtual

Destructor.

Definition at line 49 of file AbstractImmersedBoundaryForce.cpp.

Member Function Documentation

◆ AddImmersedBoundaryForceContribution()

template<unsigned DIM>

virtual void AbstractImmersedBoundaryForce< DIM >::AddImmersedBoundaryForceContribution	(	std::vector< std::pair< Node< DIM > , Node< DIM > > > &	rNodePairs,
		ImmersedBoundaryCellPopulation< DIM > &	rCellPopulation
	)

pure virtual

Calculates the force on each immersed boundary node. As this method is pure virtual, it must be overridden in subclasses.

Parameters

rNodePairs	reference to a vector set of node pairs between which to contribute the force
rCellPopulation	an immersed boundary cell population

Implemented in ImmersedBoundaryKinematicFeedbackForce< DIM >, ImmersedBoundaryLinearDifferentialAdhesionForce< DIM >, ImmersedBoundaryLinearInteractionForce< DIM >, ImmersedBoundaryLinearMembraneForce< DIM >, ImmersedBoundaryMorseInteractionForce< DIM >, and ImmersedBoundaryMorseMembraneForce< DIM >.

◆ AddNormalNoiseToNodes()

template<unsigned DIM>

void AbstractImmersedBoundaryForce< DIM >::AddNormalNoiseToNodes ( ImmersedBoundaryCellPopulation< DIM > & rCellPopulation )

protected

Add the random noise to nodes, if mAdditiveNormalNoise is set. This method handles randomization of the forces in such a way as to ensure no net change to forces across the whole domain.

Parameters

rCellPopulation an immersed boundary cell population

Definition at line 54 of file AbstractImmersedBoundaryForce.cpp.

References Node< SPACE_DIM >::AddAppliedForceContribution(), ImmersedBoundaryCellPopulation< DIM >::GetElement(), ImmersedBoundaryCellPopulation< DIM >::GetLamina(), ImmersedBoundaryCellPopulation< DIM >::GetNumElements(), ImmersedBoundaryCellPopulation< DIM >::GetNumLaminas(), RandomNumberGenerator::Instance(), RandomNumberGenerator::NormalRandomDeviate(), and Node< SPACE_DIM >::rGetAppliedForce().