Nalu: TestAlgorithm Class Reference

Nalu

Nalu: a generalized unstructured massively parallel low Mach flow code designed to support a variety of energy applications of interest (most notably Wind ECP) built on the Sierra Toolkit and Trilinos solver Tpetra/Epetra stack. The open source BSD, clause 3 license model has been chosen for the code base. See LICENSE for more information. http://NaluCFD.org

#include <UnitTestAlgorithm.h>

Inheritance diagram for TestAlgorithm:

Public Member Functions
	TestAlgorithm ()

virtual	~TestAlgorithm ()

sierra::nalu::Realm &	create_realm (const YAML::Node &realm_node, const std::string realm_type="multi_physics")

sierra::nalu::Realm &	create_realm (const std::string realm_type="multi_physics")

void	fill_mesh (const std::string mesh_spec="generated:10x10x10")

virtual void	declare_fields ()=0

sierra::nalu::Realm &	realm () const

stk::mesh::MetaData &	meta () const

stk::mesh::BulkData &	bulk () const

double	field_norm (const ScalarFieldType &field, stk::mesh::Selector *selector=nullptr)

Public Attributes
std::unique_ptr< unit_test_utils::NaluTest >	naluObj_
	Reference to test Nalu instance used to hold Simulation and Realm. More...

sierra::nalu::Realm *	realm_ {nullptr}
	Reference to realm instance. More...

stk::mesh::Part *	meshPart_ {nullptr}

const VectorFieldType *	coordinates_ {nullptr}

stk::ParallelMachine	comm_

Constructor & Destructor Documentation

TestAlgorithm::TestAlgorithm ( )

inline

References unit_test_utils::get_default_inputs(), and naluObj_.

virtual TestAlgorithm::~TestAlgorithm ( )

inlinevirtual

Member Function Documentation

stk::mesh::BulkData& TestAlgorithm::bulk ( ) const

inline

References sierra::nalu::Realm::bulk_data(), field_norm(), and realm().

Referenced by field_norm(), fill_mesh(), and TestTurbulenceAlgorithm::fill_mesh_and_init_fields().

sierra::nalu::Realm& TestAlgorithm::create_realm	(	const YAML::Node &	realm_node,
		const std::string	realm_type = `"multi_physics"`
	)

inline

References naluObj_, and realm_.

sierra::nalu::Realm& TestAlgorithm::create_realm ( const std::string realm_type = "multi_physics" )

inline

References declare_fields(), fill_mesh(), unit_test_utils::get_realm_default_node(), naluObj_, and realm_.

virtual void TestAlgorithm::declare_fields ( )

pure virtual

Implemented in TestTurbulenceAlgorithm.

Referenced by create_realm(), fill_mesh(), and TestTurbulenceAlgorithm::~TestTurbulenceAlgorithm().

double TestAlgorithm::field_norm	(	const ScalarFieldType &	field,
		stk::mesh::Selector *	selector = `nullptr`
	)

References bulk(), unit_test_utils::field_norm(), and meta().

Referenced by bulk().

void TestAlgorithm::fill_mesh ( const std::string mesh_spec = "generated:10x10x10" )

References bulk(), coordinates_, declare_fields(), unit_test_utils::fill_hex8_mesh(), meshPart_, and meta().

Referenced by create_realm(), and TestTurbulenceAlgorithm::fill_mesh_and_init_fields().

stk::mesh::MetaData& TestAlgorithm::meta ( ) const

inline

References sierra::nalu::Realm::meta_data(), and realm().

Referenced by TestTurbulenceAlgorithm::declare_fields(), field_norm(), and fill_mesh().

sierra::nalu::Realm& TestAlgorithm::realm ( ) const

inline

References realm_.

Referenced by bulk(), and meta().

Member Data Documentation

stk::ParallelMachine TestAlgorithm::comm_

const VectorFieldType* TestAlgorithm::coordinates_ {nullptr}

Referenced by fill_mesh(), and TestTurbulenceAlgorithm::fill_mesh_and_init_fields().

stk::mesh::Part* TestAlgorithm::meshPart_ {nullptr}

Referenced by fill_mesh().

std::unique_ptr<unit_test_utils::NaluTest> TestAlgorithm::naluObj_

Reference to test Nalu instance used to hold Simulation and Realm.

Referenced by create_realm(), and TestAlgorithm().

sierra::nalu::Realm* TestAlgorithm::realm_ {nullptr}

Reference to realm instance.

Referenced by create_realm(), and realm().

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