ParallelColumnDataWriter Class Reference

#include <ParallelColumnDataWriter.hpp>

Inheritance diagram for ParallelColumnDataWriter:

Collaboration diagram for ParallelColumnDataWriter:

List of all members.

Public Member Functions

ParallelColumnDataWriter (const std::string &rDirectory, const std::string &rBaseName, bool cleanDirectory=true)

virtual ~ParallelColumnDataWriter ()

void PutVector (int variableID, Vec petscVector)

void PutVectorStripe (int variableId, DistributedVector::Stripe &rStripe)

void PutVariable (int variableID, double variableValue, long dimensionPosition=-1)

void EndDefineMode ()

void AdvanceAlongUnlimitedDimension ()

void Close ()

Private Attributes

bool mIsParallel

Vec mConcentrated

VecScatter mToMaster

Detailed Description

A parallelised column data writer class.

Definition at line 41 of file ParallelColumnDataWriter.hpp.

Constructor & Destructor Documentation

ParallelColumnDataWriter::ParallelColumnDataWriter	(	const std::string &	rDirectory,
		const std::string &	rBaseName,
		bool	cleanDirectory = `true`
	)

Constructor.

Parameters:

	rDirectory	the directory in which to write the data to file
	rBaseName	the name of the file in which to write the data
	cleanDirectory	whether to clean the directory (defaults to true)

Definition at line 33 of file ParallelColumnDataWriter.cpp.

References mIsParallel.

ParallelColumnDataWriter::~ParallelColumnDataWriter ( ) [virtual]

Destructor.

Definition at line 142 of file ParallelColumnDataWriter.cpp.

References Close(), mConcentrated, and mToMaster.

Member Function Documentation

void ParallelColumnDataWriter::PutVector	(	int	variableID,
		Vec	petscVector
	)

Write data for a given variable from a Petsc vector to the dataset.

Parameters:

	variableID	the variable
	petscVector	the data

Definition at line 51 of file ParallelColumnDataWriter.cpp.

References PetscTools::AmMaster(), EXCEPTION, mConcentrated, ColumnDataWriter::mFixedDimensionSize, mToMaster, and ColumnDataWriter::PutVariable().

Referenced by PutVectorStripe().

void ParallelColumnDataWriter::PutVectorStripe	(	int	variableId,
		DistributedVector::Stripe &	rStripe
	)

Write data for a given variable from a stripe to the dataset.

Parameters:

	variableId	the variable
	rStripe	the data

Todo:: allow this to be a const-reference

Definition at line 95 of file ParallelColumnDataWriter.cpp.

References DistributedVector::Begin(), DistributedVectorFactory::CreateDistributedVector(), DistributedVectorFactory::CreateVec(), DistributedVector::End(), DistributedVector::Stripe::GetFactory(), and PutVector().

void ParallelColumnDataWriter::PutVariable	(	int	variableID,
		double	variableValue,
		long	dimensionPosition = `-1`
	)			`[virtual]`

Input the variable value to the output file or ancillary file

Parameters:

	variableID
	variableValue
	dimensionPosition	The position in column (defaults to -1). This is required if there is a fixed dimension, and will be the position along that dimension

There are two ways of calling PutVariable: 1) All processes call it as a collective operation from the user's code. This only makes sense if they are writing the unlimited dimension (time) variable. It is actually a no-op if any non-master process attempts to write anything at all. 2) The master calls the equivalent method in the parent class after concentrating the data into a single Vec (ie. from the method PutVector() above).

Reimplemented from ColumnDataWriter.

Definition at line 133 of file ParallelColumnDataWriter.cpp.

References PetscTools::AmMaster(), and ColumnDataWriter::PutVariable().

void ParallelColumnDataWriter::EndDefineMode ( ) [virtual]

End the define mode of the DataWriter.

Reimplemented from ColumnDataWriter.

Definition at line 113 of file ParallelColumnDataWriter.cpp.

References PetscTools::AmMaster(), ColumnDataWriter::EndDefineMode(), and ColumnDataWriter::mIsInDefineMode.

void ParallelColumnDataWriter::AdvanceAlongUnlimitedDimension ( ) [virtual]

Advance along the unlimited dimension. Normally this will be called when all variables in a row have been input.

Reimplemented from ColumnDataWriter.

Definition at line 152 of file ParallelColumnDataWriter.cpp.

References PetscTools::AmMaster(), PetscTools::Barrier(), and ColumnDataWriter::DoAdvanceAlongUnlimitedDimension().

void ParallelColumnDataWriter::Close ( ) [virtual]

Close any open files.

Reimplemented from ColumnDataWriter.

Definition at line 163 of file ParallelColumnDataWriter.cpp.

References PetscTools::AmMaster(), PetscTools::Barrier(), and ColumnDataWriter::Close().

Referenced by ~ParallelColumnDataWriter().

Member Data Documentation

bool ParallelColumnDataWriter::mIsParallel [private]

Set to true in constructor if running in parallel

Definition at line 45 of file ParallelColumnDataWriter.hpp.

Referenced by ParallelColumnDataWriter().

Vec ParallelColumnDataWriter::mConcentrated [private]

Vector to hold concentrated copy of distributed vector on the master process

Definition at line 46 of file ParallelColumnDataWriter.hpp.

Referenced by PutVector(), and ~ParallelColumnDataWriter().

VecScatter ParallelColumnDataWriter::mToMaster [private]

variable holding information for concentrating a vector

Definition at line 47 of file ParallelColumnDataWriter.hpp.

Referenced by PutVector(), and ~ParallelColumnDataWriter().

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

io/src/writer/ParallelColumnDataWriter.hpp
io/src/writer/ParallelColumnDataWriter.cpp


Public Member Functions
	ParallelColumnDataWriter (const std::string &rDirectory, const std::string &rBaseName, bool cleanDirectory=true)
virtual	~ParallelColumnDataWriter ()
void	PutVector (int variableID, Vec petscVector)
void	PutVectorStripe (int variableId, DistributedVector::Stripe &rStripe)
void	PutVariable (int variableID, double variableValue, long dimensionPosition=-1)
void	EndDefineMode ()
void	AdvanceAlongUnlimitedDimension ()
void	Close ()
Private Attributes
bool	mIsParallel
Vec	mConcentrated
VecScatter	mToMaster