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
Public Member Functions | Public Attributes | List of all members
sierra::nalu::LowMachEquationSystem Class Reference

#include <LowMachEquationSystem.h>

Inheritance diagram for sierra::nalu::LowMachEquationSystem:
sierra::nalu::EquationSystem

Public Member Functions

 LowMachEquationSystem (EquationSystems &equationSystems, const bool elementContinuityEqs)
 
virtual ~LowMachEquationSystem ()
 
virtual void initialize ()
 
virtual void register_nodal_fields (stk::mesh::Part *part)
 
virtual void register_edge_fields (stk::mesh::Part *part)
 
virtual void register_element_fields (stk::mesh::Part *part, const stk::topology &theTopo)
 
virtual void register_interior_algorithm (stk::mesh::Part *part)
 
virtual void register_open_bc (stk::mesh::Part *part, const stk::topology &theTopo, const OpenBoundaryConditionData &openBCData)
 
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 pre_iter_work ()
 Perform setup tasks before entering the solve and update step. More...
 
virtual void solve_and_update ()
 Assemble the LHS and RHS and perform linear solve for prescribed number of iterations. More...
 
virtual void post_adapt_work ()
 
virtual void predict_state ()
 
void project_nodal_velocity ()
 
void post_converged_work ()
 
- 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 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 dump_eq_time ()
 
virtual double provide_scaled_norm ()
 
virtual double provide_norm ()
 
virtual double provide_norm_increment ()
 
virtual bool system_is_converged ()
 
virtual void register_wall_bc (stk::mesh::Part *part, const stk::topology &theTopo, const WallBoundaryConditionData &wallBCData)
 
virtual void register_inflow_bc (stk::mesh::Part *part, const stk::topology &theTopo, const InflowBoundaryConditionData &inflowBCData)
 
virtual void register_symmetry_bc (stk::mesh::Part *part, const stk::topology &theTopo, const SymmetryBoundaryConditionData &symmetryBCData)
 
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 register_non_conformal_bc (stk::mesh::Part *part, const stk::topology &theTopo)
 
virtual void register_overset_bc ()
 
virtual void create_constraint_algorithm (stk::mesh::FieldBase *theField)
 
virtual void evaluate_properties ()
 
PecletFunctioncreate_peclet_function (const std::string dofName)
 
virtual void load (const YAML::Node &node)
 
Simulationroot ()
 
EquationSystemsparent ()
 
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)
 

Public Attributes

const bool elementContinuityEqs_
 
MomentumEquationSystemmomentumEqSys_
 
ContinuityEquationSystemcontinuityEqSys_
 
ScalarFieldTypedensity_
 
ScalarFieldTypeviscosity_
 
ScalarFieldTypedualNodalVolume_
 
VectorFieldTypeedgeAreaVec_
 
SurfaceForceAndMomentAlgorithmDriversurfaceForceAndMomentAlgDriver_
 
bool isInit_
 
- Public Attributes inherited from sierra::nalu::EquationSystem
EquationSystemsequationSystems_
 
Realmrealm_
 
std::string name_
 
std::string userSuppliedName_
 
const std::string eqnTypeName_
 
int maxIterations_
 
double convergenceTolerance_
 
SolverAlgorithmDriversolverAlgDriver_
 
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_
 
LinearSystemlinsys_
 
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::LowMachEquationSystem::LowMachEquationSystem ( EquationSystems equationSystems,
const bool  elementContinuityEqs 
)
sierra::nalu::LowMachEquationSystem::~LowMachEquationSystem ( )
virtual

Member Function Documentation

void sierra::nalu::LowMachEquationSystem::initialize ( )
virtual
void sierra::nalu::LowMachEquationSystem::post_adapt_work ( )
virtual
void sierra::nalu::LowMachEquationSystem::post_converged_work ( )
virtual
void sierra::nalu::LowMachEquationSystem::pre_iter_work ( )
virtual

Perform setup tasks before entering the solve and update step.

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

// Iterate over all equation systems
for (auto eqsys: equationSystems_) {
eqsys->pre_iter_work(); //<<<< Pre-iteration setup
eqsys->solve_and_update();
eqsys->post_iter_work();
}
See also
EquationSystems::solve_and_update

Reimplemented from sierra::nalu::EquationSystem.

References continuityEqSys_, momentumEqSys_, and sierra::nalu::EquationSystem::pre_iter_work().

void sierra::nalu::LowMachEquationSystem::predict_state ( )
virtual

Reimplemented from sierra::nalu::EquationSystem.

void sierra::nalu::LowMachEquationSystem::project_nodal_velocity ( )
void sierra::nalu::LowMachEquationSystem::register_edge_fields ( stk::mesh::Part *  part)
virtual
void sierra::nalu::LowMachEquationSystem::register_element_fields ( stk::mesh::Part *  part,
const stk::topology &  theTopo 
)
virtual
void sierra::nalu::LowMachEquationSystem::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 sierra::nalu::LowMachEquationSystem::register_interior_algorithm ( stk::mesh::Part *  part)
virtual
void sierra::nalu::LowMachEquationSystem::register_nodal_fields ( stk::mesh::Part *  part)
virtual
void sierra::nalu::LowMachEquationSystem::register_open_bc ( stk::mesh::Part *  part,
const stk::topology &  theTopo,
const OpenBoundaryConditionData openBCData 
)
virtual
void sierra::nalu::LowMachEquationSystem::register_surface_pp_algorithm ( const PostProcessingData theData,
stk::mesh::PartVector partVector 
)
virtual
void sierra::nalu::LowMachEquationSystem::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

// 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();
}
See also
EquationSystems::solve_and_update

Reimplemented from sierra::nalu::EquationSystem.

References sierra::nalu::EquationSystem::assemble_and_solve(), sierra::nalu::Realm::bulk_data(), sierra::nalu::MomentumEquationSystem::cflReyAlgDriver_, sierra::nalu::MomentumEquationSystem::compute_projected_nodal_gradient(), sierra::nalu::ContinuityEquationSystem::compute_projected_nodal_gradient(), sierra::nalu::Realm::compute_vrtm(), sierra::nalu::MomentumEquationSystem::compute_wall_function_params(), sierra::nalu::ContinuityEquationSystem::computeMdotAlgDriver_, continuityEqSys_, sierra::nalu::MomentumEquationSystem::diffFluxCoeffAlgDriver_, sierra::nalu::AlgorithmDriver::execute(), sierra::nalu::field_axpby(), sierra::nalu::Realm::get_activate_aura(), isInit_, sierra::nalu::EquationSystem::maxIterations_, sierra::nalu::Realm::meta_data(), momentumEqSys_, sierra::nalu::NaluEnv::nalu_time(), sierra::nalu::NaluEnv::naluOutputP0(), sierra::nalu::ContinuityEquationSystem::pressure_, project_nodal_velocity(), sierra::nalu::ContinuityEquationSystem::pTmp_, sierra::nalu::EquationSystem::realm_, sierra::nalu::NaluEnv::self(), sierra::nalu::EquationSystem::timerAssemble_, sierra::nalu::EquationSystem::timerMisc_, sierra::nalu::MomentumEquationSystem::tviscAlgDriver_, sierra::nalu::EquationSystem::userSuppliedName_, sierra::nalu::MomentumEquationSystem::uTmp_, and sierra::nalu::MomentumEquationSystem::velocity_.

Member Data Documentation

ContinuityEquationSystem* sierra::nalu::LowMachEquationSystem::continuityEqSys_
ScalarFieldType* sierra::nalu::LowMachEquationSystem::density_
ScalarFieldType* sierra::nalu::LowMachEquationSystem::dualNodalVolume_

Referenced by register_nodal_fields().

VectorFieldType* sierra::nalu::LowMachEquationSystem::edgeAreaVec_

Referenced by register_edge_fields().

const bool sierra::nalu::LowMachEquationSystem::elementContinuityEqs_
bool sierra::nalu::LowMachEquationSystem::isInit_

Referenced by solve_and_update().

MomentumEquationSystem* sierra::nalu::LowMachEquationSystem::momentumEqSys_
SurfaceForceAndMomentAlgorithmDriver* sierra::nalu::LowMachEquationSystem::surfaceForceAndMomentAlgDriver_
ScalarFieldType* sierra::nalu::LowMachEquationSystem::viscosity_

Referenced by register_nodal_fields().


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