plascom2 Namespace Reference

Detailed Description

Namespace for everything PlasCom2-specific.

Namespaces
	io
	operators
	Namespace for PlasCom2 numerical operators and associated data structures.
	TestFixture
	Namespace for storing simple test utility fixtures.
	util

Classes
class	application
class	ParallelTestingObject
	Project-specific parallel testing object. More...
struct	process_info
class	TestComLine
	ComLineObject for PlasCom2 testing command-line interface. More...
class	TestingObject
	Project-specific testing object. More...

Typedefs
typedef simulation::grid::parallel_blockstructured	grid_t
typedef simulation::state::base	state_t
typedef simulation::grid::halo	halo_t
typedef simulation::domain::base< grid_t, state_t >	domain_t
typedef simulation::application< domain_t >	application_t
typedef ix::test::results	TestResults
	Project-specific test results type. More...
typedef ix::comm::CommunicatorObject	CommType
	Convenience typedef for CommunicatorObject. More...

Functions
template<typename GridType >
int	GenerateGrid (GridType &inGrid, const std::string &gridName, const fixtures::ConfigurationType &inConfig, std::ostream &messageStream)
std::string	VirtualNodeReport (pcpp::VirtualNodeType &virtualNode)
	Reports the virtual node setup. More...
std::string	Splash ()
std::string	IORootName ()
int	ParallelTest (int argc, char *argv[])
	Drives the PlasCom2::TestObject. More...
int	Test (int argc, char *argv[])
	Drives the plascom2::TestObject. More...

Typedef Documentation

application_t

typedef simulation::application<domain_t> application_t

Definition at line 20 of file PlasCom2.H.

CommType

typedef ix::comm::CommunicatorObject CommType

Convenience typedef for CommunicatorObject.

Definition at line 20 of file PC2ParallelTestDriver.C.

domain_t

typedef simulation::domain::base<grid_t,state_t> domain_t

Definition at line 19 of file PlasCom2.H.

grid_t

typedef simulation::grid::parallel_blockstructured grid_t

Definition at line 16 of file PlasCom2.H.

halo_t

typedef simulation::grid::halo halo_t

Definition at line 18 of file PlasCom2.H.

state_t

typedef simulation::state::base state_t

Definition at line 17 of file PlasCom2.H.

TestResults

typedef ix::test::results TestResults

Project-specific test results type.

Test results types can be custom implemented by the project developer. The requirement is that they produce the proper test results output when used with outstreams.

Definition at line 44 of file PlasCom2Test.H.

Function Documentation

GenerateGrid()

int plascom2::GenerateGrid	(	GridType &	inGrid,
		const std::string &	gridName,
		const fixtures::ConfigurationType &	inConfig,
		std::ostream &	messageStream
	)

Definition at line 173 of file PC2Configuration.C.

References gridgen::Cylinder2D(), Parameters::GetValue(), and Parameters::GetValueVector().

Referenced by application::ConfigureSimulation(), and parallel_blockstructured::Halo().

Here is the call graph for this function:

Here is the caller graph for this function:

IORootName()

std::string plascom2::IORootName

(

)

Definition at line 8 of file PC2WriteDomains.C.

ParallelTest()

int plascom2::ParallelTest	(	int	argc,
		char *	argv[]
	)

Drives the PlasCom2::TestObject.

Parameters

argc	number of string command line tokens
argv	string command line tokens

Returns

0 if successful, 1 otherwise

Drives the PlasCom2::TestObject, which should encapsulate all the tests for the PlasCom2 namespace (and thus the project).

Command line documentation:

      plascom2_test [-h] [-v [level] -o <filename> -l <filename> -n <TestName> ] 

      -h,--help
         Print out long version of help and exit.

      -v,--verblevel [level]
         Set the verbosity level. (default = 0)

      -o,--output <filename>
         Set the output file to <filename>. (default = stdout)

      -l,--list <filename>
         Set the list file name to <filename>. (no default). The list file should be a text file with one test name per line.

      -n,--name <TestName>
         Run test by name. (no default)

Definition at line 50 of file PC2ParallelTestDriver.C.

References CommunicatorObject::Barrier(), CommunicatorObject::Check(), ComLineObject::ErrorReport(), ComLineObject::GetOption(), TestComLine::Initialize(), ComLineObject::LongUsage(), ParallelTestingObject< CommType, ResultsType >::Process(), ComLineObject::ProcessOptions(), CommunicatorObject::Rank(), ParallelTestingObject< CommType, ResultsType >::RunTest(), CommunicatorObject::SetExit(), ComLineObject::ShortUsage(), and CommunicatorObject::Size().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

Splash()

std::string plascom2::Splash

(

)

Definition at line 26 of file PC2Initialize.C.

Referenced by application::InitializeApplication().

Here is the caller graph for this function:

Test()

int plascom2::Test	(	int	argc,
		char *	argv[]
	)

Drives the plascom2::TestObject.

Parameters

argc	number of string command line tokens
argv	string command line tokens

Returns

0 if successful, 1 otherwise

Drives the PlasCom2::TestObject, which should encapsulate all the tests for the PlasCom2 namespace (and thus the project).

Command line documentation:

      plascom2_test [-h] [-v [level] -o <filename> -l <filename> -n <TestName> ] 

      -h,--help
         Print out long version of help and exit.

      -v,--verblevel [level]
         Set the verbosity level. (default = 0)

      -o,--output <filename>
         Set the output file to <filename>. (default = stdout)

      -l,--list <filename>
         Set the list file name to <filename>. (no default). The list file should be a text file with one test name per line.

      -n,--name <TestName>
         Run test by name. (no default)

Definition at line 45 of file PC2TestDriver.C.

References ComLineObject::ErrorReport(), ComLineObject::GetOption(), TestComLine::Initialize(), ComLineObject::LongUsage(), TestingObject< ResultsType >::Process(), ComLineObject::ProcessOptions(), TestingObject< ResultsType >::RunTest(), and ComLineObject::ShortUsage().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

VirtualNodeReport()

std::string plascom2::VirtualNodeReport

(

pcpp::VirtualNodeType &

virtualNode

)

Reports the virtual node setup.

Produces a report string for the virtual node setup including:

• How many virtual nodes
• How many processes/virtual node
• How many IO/virtual node
• Whether IO processes perform Computation
• Whether local processor is IO or compute
• How many of each type (IO/Compute) total

virtualNode a pcpp::VirtualNodeType data object report a std::string with the formated report text

Definition at line 499 of file PC2Configuration.C.

References virtual_node::computeCommunicator, virtual_node::computeRank, virtual_node::ioCommunicator, virtual_node::ioPerNode, virtual_node::ioRank, virtual_node::numNodes, virtual_node::performCompute, virtual_node::performIO, virtual_node::procsPerNode, and CommunicatorObject::Size().

Referenced by application::ConfigureSimulation().

Here is the call graph for this function:

Here is the caller graph for this function: