Chaste  Build::
Public Member Functions | Protected Attributes | List of all members
AbstractStructuralAdaptationSolver< DIM > Class Template Referenceabstract

#include <AbstractStructuralAdaptationSolver.hpp>

+ Inheritance diagram for AbstractStructuralAdaptationSolver< DIM >:
+ Collaboration diagram for AbstractStructuralAdaptationSolver< DIM >:

Public Member Functions

 AbstractStructuralAdaptationSolver ()
 
virtual ~AbstractStructuralAdaptationSolver ()
 
double GetTolerance () const
 
bool GetWriteOutput () const
 
std::string GetOutputFileName () const
 
units::quantity< unit::time > GetTimeIncrement () const
 
virtual void Iterate ()=0
 
void SetTolerance (double tolerance)
 
void SetTimeIncrement (units::quantity< unit::time > timeIncrement)
 
void SetMaxIterations (unsigned iterations)
 
void SetWriteOutput (bool writeFlag)
 
void SetOutputFileName (const std::string &rFilename)
 
void SetVesselNetwork (boost::shared_ptr< VesselNetwork< DIM > > pNetwork)
 
void Solve ()
 
virtual void Write ()
 

Protected Attributes

double mTolerance
 
units::quantity< unit::time > mTimeIncrement
 
units::quantity< unit::time > mReferenceTimeScale
 
bool mWriteOutput
 
std::string mOutputFileName
 
unsigned mMaxIterations
 
boost::shared_ptr< VesselNetwork< DIM > > mpVesselNetwork
 

Detailed Description

template<unsigned DIM>
class AbstractStructuralAdaptationSolver< DIM >

This is an abstract implementation of a structural adaptation solver. It iterates until the vessel radii stop changing. Child classes implement the specific updates of the radii in each iteration.

Definition at line 51 of file AbstractStructuralAdaptationSolver.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>
AbstractStructuralAdaptationSolver< DIM >::AbstractStructuralAdaptationSolver ( )

Constructor

Definition at line 43 of file AbstractStructuralAdaptationSolver.cpp.

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

Destructor.

Definition at line 56 of file AbstractStructuralAdaptationSolver.cpp.

Member Function Documentation

template<unsigned DIM>
std::string AbstractStructuralAdaptationSolver< DIM >::GetOutputFileName ( ) const

Returns the filename for the file that the progress of the algorithm will be output to.

Returns
the filename to write to

Definition at line 74 of file AbstractStructuralAdaptationSolver.cpp.

References AbstractStructuralAdaptationSolver< DIM >::mOutputFileName.

template<unsigned DIM>
units::quantity< unit::time > AbstractStructuralAdaptationSolver< DIM >::GetTimeIncrement ( ) const

Returns the timeStep (in seconds).

Returns
the time step

Definition at line 80 of file AbstractStructuralAdaptationSolver.cpp.

References AbstractStructuralAdaptationSolver< DIM >::mTimeIncrement.

Referenced by StructuralAdaptationSolver< DIM >::Iterate().

template<unsigned DIM>
double AbstractStructuralAdaptationSolver< DIM >::GetTolerance ( ) const

Return the tolerance for change in radii

Returns
the tolerance for change in radii

Definition at line 62 of file AbstractStructuralAdaptationSolver.cpp.

References AbstractStructuralAdaptationSolver< DIM >::mTolerance.

template<unsigned DIM>
bool AbstractStructuralAdaptationSolver< DIM >::GetWriteOutput ( ) const

Return whether the progress of the structural adaptation algorithm will be output to a file.

Returns
whether to write to file

Definition at line 68 of file AbstractStructuralAdaptationSolver.cpp.

References AbstractStructuralAdaptationSolver< DIM >::mWriteOutput.

template<unsigned DIM>
virtual void AbstractStructuralAdaptationSolver< DIM >::Iterate ( )
pure virtual

This method should contain all of the operations used within a single iteration of a structural adaptation algorithm.

Implemented in StructuralAdaptationSolver< DIM >.

Referenced by AbstractStructuralAdaptationSolver< DIM >::Solve().

template<unsigned DIM>
void AbstractStructuralAdaptationSolver< DIM >::SetMaxIterations ( unsigned  iterations)

Setter for maximum number of iterations.

Parameters
iterationsthe maximum number of iterations.

Definition at line 98 of file AbstractStructuralAdaptationSolver.cpp.

References AbstractStructuralAdaptationSolver< DIM >::mMaxIterations.

template<unsigned DIM>
void AbstractStructuralAdaptationSolver< DIM >::SetOutputFileName ( const std::string &  rFilename)

Setter for name of output file that progression of structural adaptation algorithm may be output to.

Parameters
rFilenamethe output filename

Definition at line 110 of file AbstractStructuralAdaptationSolver.cpp.

References AbstractStructuralAdaptationSolver< DIM >::mOutputFileName.

template<unsigned DIM>
void AbstractStructuralAdaptationSolver< DIM >::SetTimeIncrement ( units::quantity< unit::time >  timeIncrement)

Setter for timeStep parameter.

Parameters
timeIncrementthe time increment

Definition at line 92 of file AbstractStructuralAdaptationSolver.cpp.

References AbstractStructuralAdaptationSolver< DIM >::mTimeIncrement.

template<unsigned DIM>
void AbstractStructuralAdaptationSolver< DIM >::SetTolerance ( double  tolerance)

Setter for tolerance parameter.

Parameters
tolerancethe radius convergence tolerance

Definition at line 86 of file AbstractStructuralAdaptationSolver.cpp.

References AbstractStructuralAdaptationSolver< DIM >::mTolerance.

template<unsigned DIM>
void AbstractStructuralAdaptationSolver< DIM >::SetVesselNetwork ( boost::shared_ptr< VesselNetwork< DIM > >  pNetwork)

Set the vessel network

Parameters
pNetworkpointer to the vessel network

Definition at line 166 of file AbstractStructuralAdaptationSolver.cpp.

References AbstractStructuralAdaptationSolver< DIM >::mpVesselNetwork.

template<unsigned DIM>
void AbstractStructuralAdaptationSolver< DIM >::SetWriteOutput ( bool  writeFlag)

Set whether to output the progress of structural adaptation algorithm to a file.

Parameters
writeFlagwhether to write output

Definition at line 104 of file AbstractStructuralAdaptationSolver.cpp.

References AbstractStructuralAdaptationSolver< DIM >::mWriteOutput.

template<unsigned DIM>
void AbstractStructuralAdaptationSolver< DIM >::Solve ( )

Method used to implement a structural adaptation algorithm on a vessel network. The skeleton of an algorithm is outlined in this class. An individual iteration of an algorithm should be defined inside the Iterate method within concrete subclasses of this class.

Definition at line 116 of file AbstractStructuralAdaptationSolver.cpp.

References AbstractStructuralAdaptationSolver< DIM >::Iterate(), AbstractStructuralAdaptationSolver< DIM >::mMaxIterations, AbstractStructuralAdaptationSolver< DIM >::mOutputFileName, AbstractStructuralAdaptationSolver< DIM >::mpVesselNetwork, AbstractStructuralAdaptationSolver< DIM >::mReferenceTimeScale, AbstractStructuralAdaptationSolver< DIM >::mTimeIncrement, AbstractStructuralAdaptationSolver< DIM >::mTolerance, and AbstractStructuralAdaptationSolver< DIM >::mWriteOutput.

template<unsigned DIM>
void AbstractStructuralAdaptationSolver< DIM >::Write ( )
virtual

Method to output parameters of model to a file. The name of the object and parameter values are appended to the file.

Definition at line 172 of file AbstractStructuralAdaptationSolver.cpp.

References AbstractStructuralAdaptationSolver< DIM >::mOutputFileName.

Member Data Documentation

template<unsigned DIM>
unsigned AbstractStructuralAdaptationSolver< DIM >::mMaxIterations
protected

Maximum number of iterations which we may allow the algorithm to run for, regardless of timestep and SimulationTime::GetTimeStep().

Definition at line 88 of file AbstractStructuralAdaptationSolver.hpp.

Referenced by AbstractStructuralAdaptationSolver< DIM >::SetMaxIterations(), and AbstractStructuralAdaptationSolver< DIM >::Solve().

template<unsigned DIM>
std::string AbstractStructuralAdaptationSolver< DIM >::mOutputFileName
protected

Name of file to which the progress of the structural adaptation algorithm may be output.

Definition at line 82 of file AbstractStructuralAdaptationSolver.hpp.

Referenced by AbstractStructuralAdaptationSolver< DIM >::GetOutputFileName(), AbstractStructuralAdaptationSolver< DIM >::SetOutputFileName(), AbstractStructuralAdaptationSolver< DIM >::Solve(), and AbstractStructuralAdaptationSolver< DIM >::Write().

template<unsigned DIM>
boost::shared_ptr<VesselNetwork<DIM> > AbstractStructuralAdaptationSolver< DIM >::mpVesselNetwork
protected

The vessel network

Definition at line 93 of file AbstractStructuralAdaptationSolver.hpp.

Referenced by StructuralAdaptationSolver< DIM >::Iterate(), AbstractStructuralAdaptationSolver< DIM >::SetVesselNetwork(), AbstractStructuralAdaptationSolver< DIM >::Solve(), and StructuralAdaptationSolver< DIM >::UpdateFlowSolver().

template<unsigned DIM>
units::quantity<unit::time> AbstractStructuralAdaptationSolver< DIM >::mReferenceTimeScale
protected

The reference time scale

Definition at line 71 of file AbstractStructuralAdaptationSolver.hpp.

Referenced by AbstractStructuralAdaptationSolver< DIM >::Solve().

template<unsigned DIM>
units::quantity<unit::time> AbstractStructuralAdaptationSolver< DIM >::mTimeIncrement
protected

Length of time which the algorithm is incremented on each occasion that the Iterate function is called.

Definition at line 66 of file AbstractStructuralAdaptationSolver.hpp.

Referenced by AbstractStructuralAdaptationSolver< DIM >::GetTimeIncrement(), AbstractStructuralAdaptationSolver< DIM >::SetTimeIncrement(), and AbstractStructuralAdaptationSolver< DIM >::Solve().

template<unsigned DIM>
double AbstractStructuralAdaptationSolver< DIM >::mTolerance
protected

Threshold tolerance for the maximum relative change in radii of vessels in a vessel network, below which a structural adaptation algorithm will terminate.

Definition at line 60 of file AbstractStructuralAdaptationSolver.hpp.

Referenced by AbstractStructuralAdaptationSolver< DIM >::GetTolerance(), AbstractStructuralAdaptationSolver< DIM >::SetTolerance(), and AbstractStructuralAdaptationSolver< DIM >::Solve().

template<unsigned DIM>
bool AbstractStructuralAdaptationSolver< DIM >::mWriteOutput
protected

Whether to output the progress of the structural adaptation algorithm to a file.

Definition at line 76 of file AbstractStructuralAdaptationSolver.hpp.

Referenced by AbstractStructuralAdaptationSolver< DIM >::GetWriteOutput(), AbstractStructuralAdaptationSolver< DIM >::SetWriteOutput(), and AbstractStructuralAdaptationSolver< DIM >::Solve().

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