ParallelColumnDataWriter Class Reference

#include <ParallelColumnDataWriter.hpp>

Collaboration diagram for ParallelColumnDataWriter:

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 42 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 141 of file ParallelColumnDataWriter.cpp.

References Close(), mConcentrated, and mToMaster.

Member Function Documentation

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 151 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 162 of file ParallelColumnDataWriter.cpp.

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

Referenced by ~ParallelColumnDataWriter().

void ParallelColumnDataWriter::EndDefineMode ( ) [virtual]

End the define mode of the DataWriter.

Reimplemented from ColumnDataWriter.

Definition at line 112 of file ParallelColumnDataWriter.cpp.

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

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 132 of file ParallelColumnDataWriter.cpp.

References PetscTools::AmMaster().

Referenced by PutVector().