#include <DistributedVectorFactory.hpp>

Collaboration diagram for DistributedVectorFactory:

Public Member Functions
	DistributedVectorFactory (Vec vec)

	DistributedVectorFactory (unsigned size, PetscInt local=PETSC_DECIDE)

	DistributedVectorFactory (DistributedVectorFactory *pOriginalFactory)

	DistributedVectorFactory (unsigned lo, unsigned hi, unsigned size, unsigned numProcs=PetscTools::GetNumProcs())

	~DistributedVectorFactory ()

Vec	CreateVec ()

Vec	CreateVec (unsigned stride)

DistributedVector	CreateDistributedVector (Vec vec, bool readOnly=false)

bool	IsGlobalIndexLocal (unsigned globalIndex)

unsigned	GetLocalOwnership () const

unsigned	GetHigh () const

unsigned	GetLow () const

unsigned	GetProblemSize () const

unsigned	GetNumProcs () const

DistributedVectorFactory *	GetOriginalFactory ()

void	SetOriginalFactory (DistributedVectorFactory *pOriginalFactory)

void	SetFromFactory (DistributedVectorFactory *pFactory)

std::vector< unsigned > &	rGetGlobalLows ()

Static Public Member Functions
static void	SetCheckNumberOfProcessesOnLoad (bool checkNumberOfProcessesOnLoad=true)

static bool	CheckNumberOfProcessesOnLoad ()

Private Member Functions
void	CheckForPetsc ()

void	CalculateOwnership (Vec vec)

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

Private Attributes
unsigned	mLo

unsigned	mHi

unsigned	mProblemSize

unsigned	mNumProcs

bool	mPetscStatusKnown

std::vector< unsigned >	mGlobalLows

DistributedVectorFactory *	mpOriginalFactory

Static Private Attributes
static bool	msCheckNumberOfProcessesOnLoad = true

Friends
class	boost::serialization::access

Detailed Description

Factory for creating PETSc vectors distributed across processes.

Replacement for the vector creation portions of DistributedVector (which was implemented using static methods and data), the factory class allows several patterns of PETSc vector length (and distributions among processes) to co-exist.

All vectors created by a factory instance will have the same base size and parallelisation pattern.

Definition at line 57 of file DistributedVectorFactory.hpp.

Constructor & Destructor Documentation

◆ DistributedVectorFactory() [1/4]

DistributedVectorFactory::DistributedVectorFactory ( Vec vec )

Set the problem with an existing PETSc vector – must have stride=1.

Parameters

vec	is a PETSc vector which we want to use as the pattern for future vectors produced by this factory

Definition at line 81 of file DistributedVectorFactory.cpp.

References CalculateOwnership().

◆ DistributedVectorFactory() [2/4]

DistributedVectorFactory::DistributedVectorFactory	(	unsigned	size,
		PetscInt	local = `PETSC_DECIDE`
	)

Set the problem size specifying distribution over local processor.

Parameters

size	the problem size
local	defaults to PETSc's default

Definition at line 88 of file DistributedVectorFactory.cpp.

References CalculateOwnership(), CheckForPetsc(), PetscTools::CreateVec(), and PetscTools::Destroy().

◆ DistributedVectorFactory() [3/4]

DistributedVectorFactory::DistributedVectorFactory ( DistributedVectorFactory * pOriginalFactory )

Constructor for use in archiving. Note that this constructor is only called when the number of processes is different from the original. Therefore, the orignal local node ownership cannot be used, and a new even partition will be applied.

Parameters

pOriginalFactory see mpOriginalFactory

Definition at line 100 of file DistributedVectorFactory.cpp.

References CalculateOwnership(), PetscTools::CreateVec(), PetscTools::Destroy(), GetProblemSize(), and mpOriginalFactory.

◆ DistributedVectorFactory() [4/4]

DistributedVectorFactory::DistributedVectorFactory	(	unsigned	lo,
		unsigned	hi,
		unsigned	size,
		unsigned	numProcs = `PetscTools::GetNumProcs()`
	)

Constructor intended for use in archiving. Allows complete manual specification of the factory.

Parameters

lo	first index owned by this process
hi	one beyond last index owned by this process
size	total size of vectors
numProcs	the number of processes expected (defaults to the current number)

Definition at line 116 of file DistributedVectorFactory.cpp.

References CheckForPetsc().

◆ ~DistributedVectorFactory()

DistributedVectorFactory::~DistributedVectorFactory ( )

Destructor deletes mpOriginalFactory if it exists.

Definition at line 129 of file DistributedVectorFactory.cpp.

References mpOriginalFactory.

Member Function Documentation

◆ CalculateOwnership()

void DistributedVectorFactory::CalculateOwnership ( Vec vec )

private

Helper method for the constructors.

Parameters

vec	the sample PETSc vector from which to calculate ownerships

Definition at line 44 of file DistributedVectorFactory.cpp.

References CheckForPetsc(), PetscTools::GetNumProcs(), mGlobalLows, mHi, mLo, mNumProcs, mPetscStatusKnown, and mProblemSize.

Referenced by DistributedVectorFactory(), DistributedVectorFactory(), and DistributedVectorFactory().

◆ CheckForPetsc()

void DistributedVectorFactory::CheckForPetsc ( )

private

Double check (in debug code) that PETSc has been initialised properly.

Definition at line 134 of file DistributedVectorFactory.cpp.

References mPetscStatusKnown.

Referenced by DistributedVectorFactory(), DistributedVectorFactory(), and CalculateOwnership().

◆ CheckNumberOfProcessesOnLoad()

static bool DistributedVectorFactory::CheckNumberOfProcessesOnLoad ( )

inlinestatic

Determine whether, when loading an instance from an archive, to check that the current number of processes matches that used in creating the archive.

Returns: true when check is required

Definition at line 249 of file DistributedVectorFactory.hpp.

References msCheckNumberOfProcessesOnLoad.

◆ CreateDistributedVector()

DistributedVector DistributedVectorFactory::CreateDistributedVector	(	Vec	vec,
		bool	readOnly = `false`
	)

Create a distributed vector which wraps a given petsc vector.

Parameters

vec	is the vector
readOnly	flag to pass on to request that the distributed vector will only be used read-only

Returns: the distributed vector

Definition at line 183 of file DistributedVectorFactory.cpp.

◆ CreateVec() [1/2]

Vec DistributedVectorFactory::CreateVec ( )

Create a PETSc vector of the problem size.

Returns: new PETSc vector

Definition at line 154 of file DistributedVectorFactory.cpp.

References PetscTools::CreateVec(), mHi, mLo, and mProblemSize.

Referenced by Hdf5ToTxtConverter< ELEMENT_DIM, SPACE_DIM >::Hdf5ToTxtConverter(), Hdf5ToVtkConverter< ELEMENT_DIM, SPACE_DIM >::Hdf5ToVtkConverter(), VoltageInterpolaterOntoMechanicsMesh< DIM >::VoltageInterpolaterOntoMechanicsMesh(), AbstractCardiacProblem< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::CreateInitialCondition(), ExtendedBidomainProblem< DIM >::CreateInitialCondition(), AbstractExtendedBidomainSolver< ELEMENT_DIM, SPACE_DIM >::GenerateNullBasis(), ParallelColumnDataWriter::PutVectorStripe(), Hdf5ToCmguiConverter< ELEMENT_DIM, SPACE_DIM >::Write(), Hdf5ToMeshalyzerConverter< ELEMENT_DIM, SPACE_DIM >::Write(), and PostProcessingWriter< ELEMENT_DIM, SPACE_DIM >::WriteOutputDataToHdf5().

◆ CreateVec() [2/2]

Vec DistributedVectorFactory::CreateVec ( unsigned stride )

Create a striped PETSc vector of size: stride * problem size.

Parameters

stride

Returns: new PETSc vector

Definition at line 160 of file DistributedVectorFactory.cpp.

References mHi, mLo, and mProblemSize.

◆ GetHigh()

unsigned DistributedVectorFactory::GetHigh ( ) const

inline

Returns: mHi - The next index above the top one owned by the process.

Definition at line 204 of file DistributedVectorFactory.hpp.

References mHi.

Referenced by AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::AbstractCardiacTissue(), DistributedBoxCollection< DIM >::DistributedBoxCollection(), DistributedVector::DistributedVector(), DistributedTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::ConstructCuboid(), DistributedTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::ConstructRectangularMesh(), CardiacSimulation::CreateAndRun(), Hdf5DataWriter::DefineFixedDimension(), NodePartitioner< ELEMENT_DIM, SPACE_DIM >::DumbPartitioning(), and SetFromFactory().

◆ GetLocalOwnership()

unsigned DistributedVectorFactory::GetLocalOwnership ( ) const

inline

Returns: The number of elements in the vector owned by the local process.

Definition at line 196 of file DistributedVectorFactory.hpp.

References mHi, and mLo.

Referenced by AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::AbstractCardiacTissue(), ExtendedBidomainTissue< SPACE_DIM >::ExtendedBidomainTissue(), Hdf5DataWriter::Hdf5DataWriter(), DistributedTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::ConstructCuboid(), DistributedTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::ConstructRectangularMesh(), Hdf5DataWriter::DefineFixedDimension(), ActivationOutputModifier::InitialiseAtStart(), AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::load(), AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::LoadCardiacCells(), ExtendedBidomainTissue< SPACE_DIM >::LoadExtendedBidomainCells(), ExtendedBidomainTissue< SPACE_DIM >::LoadExtracellularStimulus(), and AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::save().

◆ GetLow()

unsigned DistributedVectorFactory::GetLow ( ) const

inline

Returns: mLo - The lowest index owned by the process.

Definition at line 212 of file DistributedVectorFactory.hpp.

References mLo.

Referenced by AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::AbstractCardiacTissue(), DistributedBoxCollection< DIM >::DistributedBoxCollection(), DistributedVector::DistributedVector(), ExtendedBidomainTissue< SPACE_DIM >::ExtendedBidomainTissue(), DistributedTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::ConstructCuboid(), DistributedTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::ConstructRectangularMesh(), CardiacSimulation::CreateAndRun(), Hdf5DataWriter::DefineFixedDimension(), NodePartitioner< ELEMENT_DIM, SPACE_DIM >::DumbPartitioning(), SingleTraceOutputModifier::InitialiseAtStart(), AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::load(), AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::LoadCardiacCells(), ExtendedBidomainTissue< SPACE_DIM >::LoadExtendedBidomainCells(), ExtendedBidomainTissue< SPACE_DIM >::LoadExtracellularStimulus(), AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::save(), and SetFromFactory().

◆ GetNumProcs()

unsigned DistributedVectorFactory::GetNumProcs ( ) const

inline

Returns: mNumProcs - how many processes this factory is expecting.

Definition at line 228 of file DistributedVectorFactory.hpp.

References mNumProcs.

Referenced by AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::load(), AbstractCardiacProblem< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::LoadExtraArchive(), CardiacSimulationArchiver< PROBLEM_CLASS >::Migrate(), AbstractMesh< ELEMENT_DIM, SPACE_DIM >::SetDistributedVectorFactory(), and SetFromFactory().

◆ GetOriginalFactory()

DistributedVectorFactory * DistributedVectorFactory::GetOriginalFactory ( )

inline

If msCheckNumberOfProcessesOnLoad is not set, and this factory was loaded from an archive, then return a factory with the settings from the archive, which may not be the same as ours - if running on a different number of processes from the original, we will have used PETSC_DECIDE to set the local ownership on load.