#include <MassFractionEquationSystem.h>

Inheritance diagram for sierra::nalu::MassFractionEquationSystem:

Public Member Functions
	MassFractionEquationSystem (EquationSystems &equationSystems, const int numMassFraction)

virtual	~MassFractionEquationSystem ()

void	register_nodal_fields (stk::mesh::Part *part)

void	register_interior_algorithm (stk::mesh::Part *part)

void	register_inflow_bc (stk::mesh::Part *part, const stk::topology &theTopo, const InflowBoundaryConditionData &inflowBCData)

void	register_open_bc (stk::mesh::Part *part, const stk::topology &theTopo, const OpenBoundaryConditionData &openBCData)

void	register_wall_bc (stk::mesh::Part *part, const stk::topology &theTopo, const WallBoundaryConditionData &wallBCData)

virtual void	register_symmetry_bc (stk::mesh::Part *part, const stk::topology &theTopo, const SymmetryBoundaryConditionData &symmetryBCData)

virtual void	register_non_conformal_bc (stk::mesh::Part *part, const stk::topology &theTopo)

virtual void	register_overset_bc ()

void	initialize ()

void	predict_state ()

void	set_current_mass_fraction (const int k)

void	copy_mass_fraction (const stk::mesh::FieldBase &fromField, const int fromFieldIndex, const stk::mesh::FieldBase &toField, const int toFieldIndex)

void	solve_and_update ()
	Assemble the LHS and RHS and perform linear solve for prescribed number of iterations. More...

void	compute_nth_mass_fraction ()

bool	system_is_converged ()

double	provide_scaled_norm ()

double	provide_norm ()

Public Member Functions inherited from sierra::nalu::EquationSystem
	EquationSystem (EquationSystems &eqSystems, const std::string name="no_name", const std::string eqnTypeName="no_eqn_type_name")

virtual	~EquationSystem ()

void	set_nodal_gradient (const std::string &dofName)

virtual void	initial_work ()

virtual void	populate_derived_quantities ()

virtual void	register_edge_fields (stk::mesh::Part *part)

virtual void	register_element_fields (stk::mesh::Part *part, const stk::topology &theTopo)

virtual void	pre_iter_work ()
	Perform setup tasks before entering the solve and update step. More...

virtual void	post_iter_work ()
	Perform setup tasks after he solve and update step. More...

virtual void	post_iter_work_dep ()
	Deprecated post iteration work logic. More...

virtual void	assemble_and_solve (stk::mesh::FieldBase *deltaSolution)

virtual void	provide_output ()

virtual void	pre_timestep_work ()

virtual void	reinitialize_linear_system ()

virtual void	post_adapt_work ()

virtual void	dump_eq_time ()

virtual double	provide_norm_increment ()

virtual void	register_periodic_bc (stk::mesh::Part partMaster, stk::mesh::Part partSlave, const stk::topology &theTopoMaster, const stk::topology &theTopoSlave, const PeriodicBoundaryConditionData &periodicBCData)

virtual void	create_constraint_algorithm (stk::mesh::FieldBase *theField)

virtual void	register_surface_pp_algorithm (const PostProcessingData &theData, stk::mesh::PartVector &partVector)

virtual void	register_initial_condition_fcn (stk::mesh::Part *part, const std::map< std::string, std::string > &theNames, const std::map< std::string, std::vector< double > > &theParams)

virtual void	evaluate_properties ()

PecletFunction *	create_peclet_function (const std::string dofName)

virtual void	load (const YAML::Node &node)

Simulation *	root ()

EquationSystems *	parent ()

void	report_invalid_supp_alg_names ()

void	report_built_supp_alg_names ()

bool	supp_alg_is_requested (std::string name)

bool	supp_alg_is_requested (std::vector< std::string >)

bool	nodal_src_is_requested ()

void	update_iteration_statistics (const int &iters)

bool	bc_data_specified (const UserData &, std::string &name)

UserDataType	get_bc_data_type (const UserData &, std::string &name)

std::string	get_bc_function_name (const UserData &, std::string &name)

std::vector< double >	get_bc_function_params (const UserData &, std::string &name)

std::vector< std::string >	get_bc_function_string_params (const UserData &, std::string &name)

virtual void	post_converged_work ()

Public Attributes
const bool	managePNG_

const int	numMassFraction_

GenericFieldType *	massFraction_

ScalarFieldType *	currentMassFraction_

VectorFieldType *	dydx_

ScalarFieldType *	yTmp_

ScalarFieldType *	visc_

ScalarFieldType *	tvisc_

ScalarFieldType *	evisc_

AssembleNodalGradAlgorithmDriver *	assembleNodalGradAlgDriver_

AlgorithmDriver *	diffFluxCoeffAlgDriver_

bool	isInit_

double	nonLinearResidualSum_

double	firstNonLinearResidualSum_

std::set< std::pair< stk::mesh::FieldBase , stk::mesh::FieldBase > >	bcMassFractionSet_

Public Attributes inherited from sierra::nalu::EquationSystem
EquationSystems &	equationSystems_

Realm &	realm_

std::string	name_

std::string	userSuppliedName_

const std::string	eqnTypeName_

int	maxIterations_

double	convergenceTolerance_

SolverAlgorithmDriver *	solverAlgDriver_

double	timerAssemble_

double	timerLoadComplete_

double	timerSolve_

double	timerMisc_

double	timerInit_

double	timerPrecond_

double	avgLinearIterations_

double	maxLinearIterations_

double	minLinearIterations_

int	nonLinearIterationCount_

bool	reportLinearIterations_

bool	firstTimeStepSolve_

bool	edgeNodalGradient_

std::vector< AuxFunctionAlgorithm * >	bcDataAlg_

std::vector< Algorithm * >	bcDataMapAlg_

std::vector< Algorithm * >	copyStateAlg_

LinearSystem *	linsys_

size_t	num_graph_entries_

std::vector< Algorithm * >	propertyAlg_

std::vector< AlgorithmDriver * >	preIterAlgDriver_
	List of tasks to be performed before each solve_and_update of this equation system. More...

std::vector< AlgorithmDriver * >	postIterAlgDriver_
	List of tasks to be performed after each solve_and_update of this equation system. More...

Constructor & Destructor Documentation

sierra::nalu::MassFractionEquationSystem::MassFractionEquationSystem	(	EquationSystems &	equationSystems,
		const int	numMassFraction
	)

References sierra::nalu::LinearSystem::create(), sierra::nalu::LinearSolvers::create_solver(), sierra::nalu::EQ_MASS_FRACTION, sierra::nalu::Realm::equationSystems_, sierra::nalu::EquationSystems::get_solver_block_name(), sierra::nalu::Simulation::linearSolvers_, sierra::nalu::EquationSystem::linsys_, managePNG_, sierra::nalu::LinearSystem::provideOutput_, sierra::nalu::Realm::push_equation_to_systems(), sierra::nalu::EquationSystem::realm_, sierra::nalu::Realm::root(), and sierra::nalu::Realm::uniformFlow_.

sierra::nalu::MassFractionEquationSystem::~MassFractionEquationSystem ( )

virtual

References assembleNodalGradAlgDriver_, and diffFluxCoeffAlgDriver_.

Member Function Documentation

void sierra::nalu::MassFractionEquationSystem::compute_nth_mass_fraction ( )

References sierra::nalu::Realm::get_buckets(), massFraction_, sierra::nalu::Realm::meta_data(), numMassFraction_, and sierra::nalu::EquationSystem::realm_.

Referenced by solve_and_update().

void sierra::nalu::MassFractionEquationSystem::copy_mass_fraction	(	const stk::mesh::FieldBase &	fromField,
		const int	fromFieldIndex,
		const stk::mesh::FieldBase &	toField,
		const int	toFieldIndex
	)

References sierra::nalu::Realm::bulk_data(), sierra::nalu::field_index_copy(), sierra::nalu::Realm::get_activate_aura(), sierra::nalu::Realm::meta_data(), and sierra::nalu::EquationSystem::realm_.

Referenced by set_current_mass_fraction(), and solve_and_update().

void sierra::nalu::MassFractionEquationSystem::initialize ( )

virtual

Reimplemented from sierra::nalu::EquationSystem.

References sierra::nalu::LinearSystem::finalizeLinearSystem(), sierra::nalu::SolverAlgorithmDriver::initialize_connectivity(), sierra::nalu::EquationSystem::linsys_, and sierra::nalu::EquationSystem::solverAlgDriver_.

void sierra::nalu::MassFractionEquationSystem::predict_state ( )

virtual

Reimplemented from sierra::nalu::EquationSystem.

References sierra::nalu::Realm::bulk_data(), sierra::nalu::field_copy(), sierra::nalu::Realm::get_activate_aura(), massFraction_, sierra::nalu::Realm::meta_data(), and sierra::nalu::EquationSystem::realm_.

double sierra::nalu::MassFractionEquationSystem::provide_norm ( )

virtual

Reimplemented from sierra::nalu::EquationSystem.

References nonLinearResidualSum_.

double sierra::nalu::MassFractionEquationSystem::provide_scaled_norm ( )

virtual

Reimplemented from sierra::nalu::EquationSystem.

References firstNonLinearResidualSum_, and nonLinearResidualSum_.

void sierra::nalu::MassFractionEquationSystem::register_inflow_bc	(	stk::mesh::Part *	part,
		const stk::topology &	theTopo,
		const InflowBoundaryConditionData &	inflowBCData
	)

virtual

void sierra::nalu::MassFractionEquationSystem::register_interior_algorithm ( stk::mesh::Part * part )

virtual

Reimplemented from sierra::nalu::EquationSystem.

References sierra::nalu::AlgorithmDriver::algMap_, assembleNodalGradAlgDriver_, currentMassFraction_, diffFluxCoeffAlgDriver_, dydx_, sierra::nalu::EquationSystem::edgeNodalGradient_, sierra::nalu::SolutionOptions::elemSrcTermsMap_, evisc_, sierra::nalu::Realm::get_lam_schmidt(), sierra::nalu::Realm::get_turb_schmidt(), sierra::nalu::INTERIOR, sierra::nalu::MASS, massFraction_, sierra::nalu::Realm::number_of_states(), sierra::nalu::EquationSystem::realm_, sierra::nalu::Realm::realmUsesEdges_, sierra::nalu::Realm::solutionOptions_, sierra::nalu::EquationSystem::solverAlgDriver_, sierra::nalu::SolverAlgorithmDriver::solverAlgMap_, sierra::nalu::SolutionOptions::srcTermsMap_, sierra::nalu::EquationSystem::supp_alg_is_requested(), sierra::nalu::Algorithm::supplementalAlg_, tvisc_, and visc_.

void sierra::nalu::MassFractionEquationSystem::register_nodal_fields ( stk::mesh::Part * part )

virtual

Reimplemented from sierra::nalu::EquationSystem.

References sierra::nalu::Realm::augment_restart_variable_list(), currentMassFraction_, dydx_, evisc_, sierra::nalu::Realm::is_turbulent(), massFraction_, sierra::nalu::Realm::meta_data(), sierra::nalu::Realm::number_of_states(), numMassFraction_, sierra::nalu::EquationSystem::realm_, tvisc_, visc_, and yTmp_.

void sierra::nalu::MassFractionEquationSystem::register_non_conformal_bc	(	stk::mesh::Part *	part,
		const stk::topology &	theTopo
	)

virtual

Reimplemented from sierra::nalu::EquationSystem.

References sierra::nalu::AlgorithmDriver::algMap_, assembleNodalGradAlgDriver_, currentMassFraction_, dydx_, sierra::nalu::EquationSystem::edgeNodalGradient_, evisc_, managePNG_, sierra::nalu::NON_CONFORMAL, sierra::nalu::EquationSystem::realm_, sierra::nalu::EquationSystem::solverAlgDriver_, and sierra::nalu::SolverAlgorithmDriver::solverAlgMap_.

void sierra::nalu::MassFractionEquationSystem::register_open_bc	(	stk::mesh::Part *	part,
		const stk::topology &	theTopo,
		const OpenBoundaryConditionData &	openBCData
	)

virtual

Reimplemented from sierra::nalu::EquationSystem.

References sierra::nalu::AlgorithmDriver::algMap_, assembleNodalGradAlgDriver_, sierra::nalu::EquationSystem::bcDataAlg_, bcMassFractionSet_, currentMassFraction_, dydx_, sierra::nalu::EquationSystem::edgeNodalGradient_, evisc_, sierra::nalu::MassFraction::massFraction_, sierra::nalu::OpenUserData::massFraction_, sierra::nalu::Realm::meta_data(), numMassFraction_, sierra::nalu::OPEN, sierra::nalu::EquationSystem::realm_, sierra::nalu::Realm::realmUsesEdges_, sierra::nalu::EquationSystem::solverAlgDriver_, sierra::nalu::SolverAlgorithmDriver::solverAlgMap_, and sierra::nalu::OpenBoundaryConditionData::userData_.

void sierra::nalu::MassFractionEquationSystem::register_overset_bc ( )

virtual

Reimplemented from sierra::nalu::EquationSystem.

References sierra::nalu::EquationSystem::create_constraint_algorithm(), currentMassFraction_, sierra::nalu::EquationSystem::equationSystems_, sierra::nalu::UpdateOversetFringeAlgorithmDriver::fields_, sierra::nalu::EquationSystems::preIterAlgDriver_, and sierra::nalu::EquationSystem::realm_.

void sierra::nalu::MassFractionEquationSystem::register_symmetry_bc	(	stk::mesh::Part *	part,
		const stk::topology &	theTopo,
		const SymmetryBoundaryConditionData &	symmetryBCData
	)

virtual

Reimplemented from sierra::nalu::EquationSystem.

References sierra::nalu::AlgorithmDriver::algMap_, assembleNodalGradAlgDriver_, currentMassFraction_, dydx_, sierra::nalu::EquationSystem::edgeNodalGradient_, sierra::nalu::EquationSystem::realm_, and sierra::nalu::SYMMETRY.

void sierra::nalu::MassFractionEquationSystem::register_wall_bc	(	stk::mesh::Part *	part,
		const stk::topology &	theTopo,
		const WallBoundaryConditionData &	wallBCData
	)

virtual

void sierra::nalu::MassFractionEquationSystem::set_current_mass_fraction ( const int k )

References bcMassFractionSet_, copy_mass_fraction(), currentMassFraction_, massFraction_, sierra::nalu::Realm::number_of_states(), and sierra::nalu::EquationSystem::realm_.

Referenced by solve_and_update().

void sierra::nalu::MassFractionEquationSystem::solve_and_update ( )

virtual

Assemble the LHS and RHS and perform linear solve for prescribed number of iterations.

This method is invoked in EquationSystems::solve_and_update method as shown below

pre_iter_work();
// Iterate over all equation systems
for (auto eqsys: equationSystems_) {
  eqsys->pre_iter_work();
  eqsys->solve_and_update();             //<<<< Assemble and solve system
  eqsys->post_iter_work();
}
post_iter_work();