inputoutput Class Reference

#include <inputoutput.h>

Public Member Functions
void	outputProperties (const string fname, const double time)
	actually write the data file
void	dumpDomainIfNeeded ()
	calls outputProperties for dumpTimes
void	writeDataFile (const string fnameRaw, const double time)
	writes the gnuplot file and calls outputProperties
void	outputHeader ()
	output header info during odt solution
void	outputProgress ()
	output data going with the header info
void	loadVarsFromRestartFile ()
void	set_iNextDumpTime (double time)
	inputoutput (const string p_inputFileDir, const int nShift)
void	init (domain *p_domn)
	~inputoutput ()

Public Attributes
domain *	domn
	pointer to domain object
ostream *	ostrm
	Runtime: points to cout or to a file.
string	caseName
	input file directory
string	inputFileDir
	input file directory
string	dataDir
	data directory (output)
YAML::Node	inputFile
	yaml input file object base node
YAML::Node	params
	yaml sub node
YAML::Node	streamProps
	yaml sub node
YAML::Node	initParams
	yaml sub node
YAML::Node	radParams
	yaml sub node
YAML::Node	dvParams
	yaml sub node
YAML::Node	dTimes
	yaml sub node
YAML::Node	dumpTimesGen
	yaml sub node
YAML::Node	bcCond
	yaml sub node
vector< double >	dumpTimes
	vector of dump times
int	iNextDumpTime
	index of next dump time
bool	LdoDump
	flag for whether we are dumping a file
ofstream	gnufile
	gnuplot script file
int	nShift
	for file naming

Detailed Description

Class implementing inputoutput object

Author

David O. Lignell

Definition at line 25 of file inputoutput.h.

Constructor & Destructor Documentation

inputoutput()

inputoutput::inputoutput	(	const string	p_caseName,
		const int	p_nShift )

inputoutput constructor function

Parameters

p_caseName	input: directory with input files
p_nShift	input: shift the file numbers by this amount (used for multiple sets of parallel runs).

< use these "nodes" to access parameters as needed

< add an extra "infinity" for easy handling of the last time

Definition at line 37 of file inputoutput.cc.

~inputoutput()

inputoutput::~inputoutput

(

)

Destructor function

Definition at line 110 of file inputoutput.cc.

Member Function Documentation

dumpDomainIfNeeded()

void inputoutput::dumpDomainIfNeeded

(

)

calls outputProperties for dumpTimes

Dumps a domain, sets flag, increments next dump

Definition at line 198 of file inputoutput.cc.

init()

void inputoutput::init

(

domain *

p_domn

)

inputoutput initialization function

Parameters

p_domn

input: set domain pointer with.

Definition at line 25 of file inputoutput.cc.

loadVarsFromRestartFile()

void inputoutput::loadVarsFromRestartFile

(

)

Restart The number of columns in the restart file should match the number and order of domainvariables that are output to a data file. (That is, the order of the domainvariables in domain).

Definition at line 285 of file inputoutput.cc.

outputHeader()

void inputoutput::outputHeader

(

)

output header info during odt solution

Output title of properties displayed to screen.

Definition at line 229 of file inputoutput.cc.

outputProgress()

void inputoutput::outputProgress

(

)

output data going with the header info

Outputs the data corresponding to outputHeader. After a given number of accepted eddies, output this info.

Definition at line 257 of file inputoutput.cc.

outputProperties()

void inputoutput::outputProperties	(	const string	fname,
		const double	time )

actually write the data file

Writes a data file of the domain properties (in order)

Parameters

fname	input: name of the file to write including path
time	input: time of the output

Definition at line 124 of file inputoutput.cc.

set_iNextDumpTime()

void inputoutput::set_iNextDumpTime

(

double

time

)

Set iNextDumpTime from time. Used for restarts.

Parameters

time	input: time to use to set iNextDumpTime.

Definition at line 185 of file inputoutput.cc.

writeDataFile()

void inputoutput::writeDataFile	(	const string	fnameRaw,
		const double	time )

writes the gnuplot file and calls outputProperties

Dumps a domain, sets flag, increments next dump

Parameters

fnameRaw	input: file name without the path (just the name).
time	input: time of the output

Definition at line 218 of file inputoutput.cc.

Member Data Documentation

bcCond

YAML::Node inputoutput::bcCond

yaml sub node

Definition at line 47 of file inputoutput.h.

caseName

string inputoutput::caseName

input file directory

Definition at line 35 of file inputoutput.h.

dataDir

string inputoutput::dataDir

data directory (output)

Definition at line 37 of file inputoutput.h.

domn

domain* inputoutput::domn

pointer to domain object

Definition at line 31 of file inputoutput.h.

dTimes

YAML::Node inputoutput::dTimes

yaml sub node

Definition at line 45 of file inputoutput.h.

dumpTimes

vector<double> inputoutput::dumpTimes

vector of dump times

Definition at line 49 of file inputoutput.h.

dumpTimesGen

YAML::Node inputoutput::dumpTimesGen

yaml sub node

Definition at line 46 of file inputoutput.h.

dvParams

YAML::Node inputoutput::dvParams

yaml sub node

Definition at line 44 of file inputoutput.h.

gnufile

ofstream inputoutput::gnufile

gnuplot script file

Definition at line 53 of file inputoutput.h.

iNextDumpTime

int inputoutput::iNextDumpTime

index of next dump time

Definition at line 50 of file inputoutput.h.

initParams

YAML::Node inputoutput::initParams

yaml sub node

Definition at line 42 of file inputoutput.h.

inputFile

YAML::Node inputoutput::inputFile

yaml input file object base node

Definition at line 39 of file inputoutput.h.

inputFileDir

string inputoutput::inputFileDir

input file directory

Definition at line 36 of file inputoutput.h.

LdoDump

bool inputoutput::LdoDump

flag for whether we are dumping a file

Definition at line 51 of file inputoutput.h.

nShift

int inputoutput::nShift

for file naming

Definition at line 55 of file inputoutput.h.

ostrm

ostream* inputoutput::ostrm

Runtime: points to cout or to a file.

Definition at line 33 of file inputoutput.h.

params

YAML::Node inputoutput::params

yaml sub node

Definition at line 40 of file inputoutput.h.

radParams

YAML::Node inputoutput::radParams

yaml sub node

Definition at line 43 of file inputoutput.h.

streamProps

YAML::Node inputoutput::streamProps

yaml sub node

Definition at line 41 of file inputoutput.h.

---

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

• inputoutput.h
• inputoutput.cc