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::SolutionOptions Class Reference

#include <SolutionOptions.h>

Public Member Functions

 SolutionOptions ()
 
 ~SolutionOptions ()
 
void load (const YAML::Node &node)
 
void initialize_turbulence_constants ()
 
bool has_mesh_motion () const
 
bool has_mesh_deformation () const
 
bool does_mesh_move () const
 
std::string get_coordinates_name () const
 
double get_mdot_interp () const
 
double get_alpha_factor (const std::string &) const
 
double get_alpha_upw_factor (const std::string &) const
 
double get_upw_factor (const std::string &) const
 
bool primitive_uses_limiter (const std::string &) const
 
bool get_shifted_grad_op (const std::string &) const
 
std::vector< double > get_gravity_vector (const unsigned nDim) const
 
double get_turb_model_constant (TurbulenceModelConstant turbModelEnum) const
 

Public Attributes

double hybridDefault_
 
double alphaDefault_
 
double alphaUpwDefault_
 
double upwDefault_
 
double lamScDefault_
 
double turbScDefault_
 
double turbPrDefault_
 
bool nocDefault_
 
bool shiftedGradOpDefault_
 
std::string tanhFormDefault_
 
double tanhTransDefault_
 
double tanhWidthDefault_
 
double referenceDensity_
 
double referenceTemperature_
 
double thermalExpansionCoeff_
 
double stefanBoltzmann_
 
double nearestFaceEntrain_
 
double includeDivU_
 
bool mdotInterpRhoUTogether_
 
bool isTurbulent_
 
TurbulenceModel turbulenceModel_
 
bool meshMotion_
 
bool meshDeformation_
 
bool externalMeshDeformation_
 
bool activateUniformRefinement_
 
bool uniformRefineSaveAfter_
 
std::vector< int > refineAt_
 
bool activateAdaptivity_
 
ErrorIndicatorType errorIndicatorType_
 
int adaptivityFrequency_
 
bool useMarker_
 
double refineFraction_
 
double unrefineFraction_
 
double physicalErrIndCriterion_
 
double physicalErrIndUnrefCriterionMultipler_
 
double maxRefinementNumberOfElementsFraction_
 
bool adapterExtraOutput_
 
bool useAdapter_
 
int maxRefinementLevel_
 
bool ncAlgGaussLabatto_
 
bool ncAlgUpwindAdvection_
 
bool ncAlgIncludePstab_
 
bool ncAlgDetailedOutput_
 
bool ncAlgCoincidentNodesErrorCheck_
 
bool ncAlgCurrentNormal_
 
bool ncAlgPngPenalty_
 
bool cvfemShiftMdot_
 
bool cvfemReducedSensPoisson_
 
double inputVariablesRestorationTime_
 
bool inputVariablesInterpolateInTime_
 
double inputVariablesPeriodicTime_
 
bool consistentMMPngDefault_
 
bool useConsolidatedSolverAlg_
 
bool eigenvaluePerturb_
 
double eigenvaluePerturbDelta_
 
int eigenvaluePerturbBiasTowards_
 
double eigenvaluePerturbTurbKe_
 
double earthAngularVelocity_
 
double latitude_
 
double mdotAlgAccumulation_
 
double mdotAlgInflow_
 
double mdotAlgOpen_
 
std::map< TurbulenceModelConstant, double > turbModelConstantMap_
 
std::map< std::string, double > hybridMap_
 
std::map< std::string, double > alphaMap_
 
std::map< std::string, double > alphaUpwMap_
 
std::map< std::string, double > upwMap_
 
std::map< std::string, bool > limiterMap_
 
std::map< std::string, std::string > tanhFormMap_
 
std::map< std::string, double > tanhTransMap_
 
std::map< std::string, double > tanhWidthMap_
 
std::map< std::string, bool > consistentMassMatrixPngMap_
 
std::map< std::string, double > lamScMap_
 
std::map< std::string, double > lamPrMap_
 
std::map< std::string, double > turbScMap_
 
std::map< std::string, double > turbPrMap_
 
std::map< std::string, std::vector< std::string > > srcTermsMap_
 
std::map< std::string, std::vector< double > > srcTermParamMap_
 
std::map< std::string, std::vector< std::string > > elemSrcTermsMap_
 
std::map< std::string, std::vector< double > > elemSrcTermParamMap_
 
std::map< std::string, std::string > nodalGradMap_
 
std::map< std::string, bool > nocMap_
 
std::map< std::string, bool > shiftedGradOpMap_
 
std::map< std::string, std::string > inputVarFromFileMap_
 
std::map< std::string, MeshMotionInfo * > meshMotionInfoMap_
 
std::vector< double > gravity_
 
std::vector< double > eastVector_
 
std::vector< double > northVector_
 
bool needPressureReference_ {false}
 Flag indicating whether the user has requested pressure referencing. More...
 
std::unique_ptr< FixPressureAtNodeInfofixPressureInfo_
 
std::string name_
 
std::string quadType_
 

Constructor & Destructor Documentation

sierra::nalu::SolutionOptions::SolutionOptions ( )
sierra::nalu::SolutionOptions::~SolutionOptions ( )

References meshMotionInfoMap_.

Member Function Documentation

bool sierra::nalu::SolutionOptions::does_mesh_move ( ) const
inline
double sierra::nalu::SolutionOptions::get_alpha_factor ( const std::string &  dofName) const
double sierra::nalu::SolutionOptions::get_alpha_upw_factor ( const std::string &  dofName) const
std::string sierra::nalu::SolutionOptions::get_coordinates_name ( ) const
inline
std::vector< double > sierra::nalu::SolutionOptions::get_gravity_vector ( const unsigned  nDim) const
double sierra::nalu::SolutionOptions::get_mdot_interp ( ) const
inline
bool sierra::nalu::SolutionOptions::get_shifted_grad_op ( const std::string &  dofName) const

References shiftedGradOpDefault_, and shiftedGradOpMap_.

Referenced by get_mdot_interp(), and load().

double sierra::nalu::SolutionOptions::get_turb_model_constant ( TurbulenceModelConstant  turbModelEnum) const

References turbModelConstantMap_.

Referenced by get_mdot_interp().

double sierra::nalu::SolutionOptions::get_upw_factor ( const std::string &  dofName) const
bool sierra::nalu::SolutionOptions::has_mesh_deformation ( ) const
inline
bool sierra::nalu::SolutionOptions::has_mesh_motion ( ) const
inline

References meshMotion_.

Referenced by does_mesh_move().

void sierra::nalu::SolutionOptions::initialize_turbulence_constants ( )
void sierra::nalu::SolutionOptions::load ( const YAML::Node node)

References activateAdaptivity_, activateUniformRefinement_, adapterExtraOutput_, adaptivityFrequency_, alphaMap_, alphaUpwMap_, sierra::nalu::case_insensitive_compare(), consistentMassMatrixPngMap_, cvfemReducedSensPoisson_, cvfemShiftMdot_, earthAngularVelocity_, eastVector_, eigenvaluePerturb_, eigenvaluePerturbBiasTowards_, eigenvaluePerturbDelta_, eigenvaluePerturbTurbKe_, sierra::nalu::EIT_LIMITER, sierra::nalu::EIT_NONE, sierra::nalu::EIT_PSTAB, sierra::nalu::EIT_SIMPLE_BASE, sierra::nalu::EIT_SIMPLE_DUDX2, sierra::nalu::EIT_SIMPLE_VORTICITY, sierra::nalu::EIT_SIMPLE_VORTICITY_DX, elemSrcTermParamMap_, elemSrcTermsMap_, errorIndicatorType_, sierra::nalu::expect_map(), sierra::nalu::expect_sequence(), externalMeshDeformation_, fixPressureInfo_, sierra::nalu::get_if_present(), sierra::nalu::get_required(), get_shifted_grad_op(), gravity_, hybridMap_, includeDivU_, sierra::nalu::NaluParsingHelper::info(), initialize_turbulence_constants(), inputVarFromFileMap_, inputVariablesInterpolateInTime_, inputVariablesPeriodicTime_, inputVariablesRestorationTime_, isTurbulent_, sierra::nalu::LAMINAR, lamPrMap_, lamScMap_, latitude_, limiterMap_, maxRefinementLevel_, maxRefinementNumberOfElementsFraction_, mdotInterpRhoUTogether_, meshDeformation_, meshMotion_, meshMotionInfoMap_, sierra::nalu::NaluEnv::naluOutputP0(), name_, ncAlgCoincidentNodesErrorCheck_, ncAlgCurrentNormal_, ncAlgDetailedOutput_, ncAlgGaussLabatto_, ncAlgIncludePstab_, ncAlgPngPenalty_, ncAlgUpwindAdvection_, nearestFaceEntrain_, needPressureReference_, nocMap_, nodalGradMap_, northVector_, OUTN, physicalErrIndCriterion_, physicalErrIndUnrefCriterionMultipler_, quadType_, referenceDensity_, referenceTemperature_, refineAt_, refineFraction_, sierra::nalu::NaluEnv::self(), shiftedGradOpMap_, sierra::nalu::FixPressureAtNodeInfo::SPATIAL_LOCATION, srcTermParamMap_, srcTermsMap_, stefanBoltzmann_, sierra::nalu::FixPressureAtNodeInfo::STK_NODE_ID, tanhFormMap_, tanhTransMap_, tanhWidthMap_, thermalExpansionCoeff_, sierra::nalu::TM_END, turbModelConstantMap_, turbPrMap_, turbScMap_, turbulenceModel_, sierra::nalu::TurbulenceModel_END, sierra::nalu::TurbulenceModelConstantNames, sierra::nalu::TurbulenceModelNames, uniformRefineSaveAfter_, unrefineFraction_, upwMap_, useAdapter_, useConsolidatedSolverAlg_, and useMarker_.

Referenced by unit_test_utils::NaluTest::create_realm(), and sierra::nalu::Realm::load().

bool sierra::nalu::SolutionOptions::primitive_uses_limiter ( const std::string &  dofName) const

Member Data Documentation

bool sierra::nalu::SolutionOptions::activateAdaptivity_
bool sierra::nalu::SolutionOptions::activateUniformRefinement_
bool sierra::nalu::SolutionOptions::adapterExtraOutput_

Referenced by load().

int sierra::nalu::SolutionOptions::adaptivityFrequency_
double sierra::nalu::SolutionOptions::alphaDefault_
std::map<std::string, double> sierra::nalu::SolutionOptions::alphaMap_
double sierra::nalu::SolutionOptions::alphaUpwDefault_
std::map<std::string, double> sierra::nalu::SolutionOptions::alphaUpwMap_
std::map<std::string, bool> sierra::nalu::SolutionOptions::consistentMassMatrixPngMap_
bool sierra::nalu::SolutionOptions::consistentMMPngDefault_
bool sierra::nalu::SolutionOptions::cvfemReducedSensPoisson_
bool sierra::nalu::SolutionOptions::cvfemShiftMdot_
double sierra::nalu::SolutionOptions::earthAngularVelocity_
std::vector<double> sierra::nalu::SolutionOptions::eastVector_
bool sierra::nalu::SolutionOptions::eigenvaluePerturb_
int sierra::nalu::SolutionOptions::eigenvaluePerturbBiasTowards_
double sierra::nalu::SolutionOptions::eigenvaluePerturbDelta_

Referenced by load().

double sierra::nalu::SolutionOptions::eigenvaluePerturbTurbKe_

Referenced by load().

std::map<std::string, std::vector<double> > sierra::nalu::SolutionOptions::elemSrcTermParamMap_

Referenced by load().

std::map<std::string, std::vector<std::string> > sierra::nalu::SolutionOptions::elemSrcTermsMap_
ErrorIndicatorType sierra::nalu::SolutionOptions::errorIndicatorType_
bool sierra::nalu::SolutionOptions::externalMeshDeformation_
std::unique_ptr<FixPressureAtNodeInfo> sierra::nalu::SolutionOptions::fixPressureInfo_
std::vector<double> sierra::nalu::SolutionOptions::gravity_
double sierra::nalu::SolutionOptions::hybridDefault_
std::map<std::string, double> sierra::nalu::SolutionOptions::hybridMap_
double sierra::nalu::SolutionOptions::includeDivU_
std::map<std::string, std::string> sierra::nalu::SolutionOptions::inputVarFromFileMap_
bool sierra::nalu::SolutionOptions::inputVariablesInterpolateInTime_
double sierra::nalu::SolutionOptions::inputVariablesPeriodicTime_
double sierra::nalu::SolutionOptions::inputVariablesRestorationTime_
bool sierra::nalu::SolutionOptions::isTurbulent_
std::map<std::string, double> sierra::nalu::SolutionOptions::lamPrMap_
double sierra::nalu::SolutionOptions::lamScDefault_
std::map<std::string, double> sierra::nalu::SolutionOptions::lamScMap_
double sierra::nalu::SolutionOptions::latitude_
std::map<std::string, bool> sierra::nalu::SolutionOptions::limiterMap_
int sierra::nalu::SolutionOptions::maxRefinementLevel_
double sierra::nalu::SolutionOptions::maxRefinementNumberOfElementsFraction_
double sierra::nalu::SolutionOptions::mdotAlgAccumulation_
double sierra::nalu::SolutionOptions::mdotAlgInflow_
double sierra::nalu::SolutionOptions::mdotAlgOpen_
bool sierra::nalu::SolutionOptions::mdotInterpRhoUTogether_
bool sierra::nalu::SolutionOptions::meshDeformation_
bool sierra::nalu::SolutionOptions::meshMotion_
std::map<std::string, MeshMotionInfo *> sierra::nalu::SolutionOptions::meshMotionInfoMap_
std::string sierra::nalu::SolutionOptions::name_

Referenced by load().

bool sierra::nalu::SolutionOptions::ncAlgCoincidentNodesErrorCheck_
bool sierra::nalu::SolutionOptions::ncAlgCurrentNormal_
bool sierra::nalu::SolutionOptions::ncAlgDetailedOutput_
bool sierra::nalu::SolutionOptions::ncAlgGaussLabatto_
bool sierra::nalu::SolutionOptions::ncAlgIncludePstab_
bool sierra::nalu::SolutionOptions::ncAlgPngPenalty_
bool sierra::nalu::SolutionOptions::ncAlgUpwindAdvection_
double sierra::nalu::SolutionOptions::nearestFaceEntrain_
bool sierra::nalu::SolutionOptions::needPressureReference_ {false}

Flag indicating whether the user has requested pressure referencing.

Referenced by sierra::nalu::ContinuityEquationSystem::initialize(), and load().

bool sierra::nalu::SolutionOptions::nocDefault_
std::map<std::string, bool> sierra::nalu::SolutionOptions::nocMap_
std::map<std::string, std::string> sierra::nalu::SolutionOptions::nodalGradMap_
std::vector<double> sierra::nalu::SolutionOptions::northVector_
double sierra::nalu::SolutionOptions::physicalErrIndCriterion_
double sierra::nalu::SolutionOptions::physicalErrIndUnrefCriterionMultipler_
std::string sierra::nalu::SolutionOptions::quadType_
double sierra::nalu::SolutionOptions::referenceDensity_
double sierra::nalu::SolutionOptions::referenceTemperature_
std::vector<int> sierra::nalu::SolutionOptions::refineAt_
double sierra::nalu::SolutionOptions::refineFraction_
bool sierra::nalu::SolutionOptions::shiftedGradOpDefault_
std::map<std::string, bool> sierra::nalu::SolutionOptions::shiftedGradOpMap_
std::map<std::string, std::vector<double> > sierra::nalu::SolutionOptions::srcTermParamMap_
std::map<std::string, std::vector<std::string> > sierra::nalu::SolutionOptions::srcTermsMap_
double sierra::nalu::SolutionOptions::stefanBoltzmann_
std::string sierra::nalu::SolutionOptions::tanhFormDefault_
std::map<std::string, std::string> sierra::nalu::SolutionOptions::tanhFormMap_
double sierra::nalu::SolutionOptions::tanhTransDefault_
std::map<std::string, double> sierra::nalu::SolutionOptions::tanhTransMap_
double sierra::nalu::SolutionOptions::tanhWidthDefault_
std::map<std::string, double> sierra::nalu::SolutionOptions::tanhWidthMap_
double sierra::nalu::SolutionOptions::thermalExpansionCoeff_
std::map<TurbulenceModelConstant, double> sierra::nalu::SolutionOptions::turbModelConstantMap_
double sierra::nalu::SolutionOptions::turbPrDefault_
std::map<std::string, double> sierra::nalu::SolutionOptions::turbPrMap_
double sierra::nalu::SolutionOptions::turbScDefault_
std::map<std::string, double> sierra::nalu::SolutionOptions::turbScMap_
TurbulenceModel sierra::nalu::SolutionOptions::turbulenceModel_
bool sierra::nalu::SolutionOptions::uniformRefineSaveAfter_

Referenced by load().

double sierra::nalu::SolutionOptions::unrefineFraction_
double sierra::nalu::SolutionOptions::upwDefault_
std::map<std::string, double> sierra::nalu::SolutionOptions::upwMap_
bool sierra::nalu::SolutionOptions::useAdapter_
bool sierra::nalu::SolutionOptions::useConsolidatedSolverAlg_
bool sierra::nalu::SolutionOptions::useMarker_

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