GRINS namespace. More...

Namespaces
	Cache

	Constants

	StringUtilities

Classes
class	AntiochChemistry
	Wrapper class for Antioch::ChemicalMixture. More...

class	AntiochConstantTransportEvaluator
	Wrapper class for evaluating constant transport properties, including Antioch::ConstantLewisDiffusivity. More...

class	AntiochConstantTransportMixture
	Wrapper class for storing state for constant transport properties, including Antioch::ConstantLewisDiffusivity. More...

class	AntiochEvaluator
	Wrapper class for evaluating chemistry and thermo properties using Antioch. More...

class	AntiochKinetics
	Wrapper class for evaluating chemical kinetics using Antioch. More...

class	AntiochMixture
	Wrapper class for storing state for Antioch thermo and kinetics. More...

class	AntiochWilkeTransportEvaluator
	Wrapper class for evaluating Wilke transport properties using Antioch. More...

class	AntiochWilkeTransportMixture
	Wrapper class for storing state for computing Wilke transport properties using Antioch. More...

class	ArrheniusCatalycity

class	AssemblyContext

class	AveragedFan
	Physics class for spatially-averaged fan. More...

class	AveragedFanAdjointStabilization
	Physics class for spatially-averaged fan. More...

class	AveragedFanBase

class	AveragedTurbine
	Physics class for spatially-averaged turbine. More...

class	AveragedTurbineAdjointStabilization
	Physics class for spatially-averaged turbine. More...

class	AveragedTurbineBase

class	AverageNusseltNumber

class	AxisymmetricBoussinesqBuoyancy
	Adds Axisymmetric Boussinesq bouyancy source term. More...

class	AxisymmetricHeatTransfer
	Physics class for Axisymmetric Heat Transfer. More...

class	AxisymmetricHeatTransferBCHandling
	Base class for reading and handling boundary conditions for physics classes. More...

class	BCHandlingBase
	Base class for reading and handling boundary conditions for physics classes. More...

class	BoundaryConditions
	Class to hold typical boundary condition methods. More...

class	BoundaryConditionsFactory
	Object for constructing boundary condition function objects. More...

class	BoussinesqBuoyancy
	Adds Boussinesq bouyancy source term. More...

class	BoussinesqBuoyancyAdjointStabilization
	Adds Boussinesq bouyancy adjoint stabilization source term. More...

class	BoussinesqBuoyancyBase

class	BoussinesqBuoyancySPGSMStabilization
	Adds Boussinesq bouyancy SPGSM stabilization source term. More...

class	CachedValues

class	CanteraEvaluator
	Wrapper class for evaluating thermochemistry and transport properties using Cantera. More...

class	CanteraKinetics

class	CanteraMixture
	Wrapper class for storing state for computing thermochemistry and transport properties using Cantera. More...

class	CanteraThermodynamics
	Wrapper class for evaluating thermo properties using Cantera. More...

class	CanteraTransport
	Wrapper class for evaluating transport properties using Cantera. More...

class	CatalycityBase

class	CatalyticWallBase

class	CompositeQoI

class	ComputeDistanceJacobian

class	ComputeDistanceResidual

class	ConcentricCylinderProfile
	Profile for flow between axially moving concentric cylinders. More...

struct	conductivity_type

class	ConstantCatalycity

class	ConstantConductivity

class	ConstantPrandtlConductivity

class	ConstantSourceFunction

class	ConstantSourceTerm

class	ConstantSpecificHeat

class	ConstantViscosity

class	DBCContainer
	Simple helper class to setup general Dirichlet boundary conditions. More...

struct	diffusivity_type

class	DisplacementContinuationSolver

class	DistanceFunction

class	ElasticCable

class	ElasticCableBase

class	ElasticCableConstantGravity

class	ElasticityTensor

class	ElasticMembrane

class	ElasticMembraneBase

class	ElasticMembraneConstantPressure

class	ErrorEstimatorFactory

class	GasRecombinationCatalyticWall

class	GasSolidCatalyticWall

class	GaussianProfile
	Gaussian profile. More...

class	GaussianXYProfile
	Gaussian profile. More...

class	GenericICHandler
	Base class for reading and handling initial conditions for physics classes. More...

class	HeatConduction

class	HeatTransfer
	Physics class for Heat Transfer. More...

class	HeatTransferAdjointStabilization
	Adds VMS-based stabilization to LowMachNavierStokes physics class. More...

class	HeatTransferBase
	Physics class for Heat Transfer. More...

class	HeatTransferBCHandling
	Base class for reading and handling boundary conditions for physics classes. More...

class	HeatTransferSource
	Adds generic, spatially dependent source term to HeatTransfer physics. More...

class	HeatTransferSPGSMStabilization
	Adds VMS-based stabilization to LowMachNavierStokes physics class. More...

class	HeatTransferStabilizationBase

class	HeatTransferStabilizationHelper

class	HookesLaw
	Elasticity tensor for Hooke's law. More...

class	HookesLaw1D
	Hooke's law specialized for one-dimensional problems. More...

class	Hyperelasticity

class	HyperelasticStrainEnergy

class	ICHandlingBase
	Base class for reading and handling initial conditions for physics classes. More...

class	IncompressibleNavierStokes
	Physics class for Incompressible Navier-Stokes. More...

class	IncompressibleNavierStokesAdjointStabilization
	Adds VMS-based stabilization to LowMachNavierStokes physics class. More...

class	IncompressibleNavierStokesBase
	Physics class for Incompressible Navier-Stokes. More...

class	IncompressibleNavierStokesBCHandling
	Base class for reading and handling boundary conditions for physics classes. More...

class	IncompressibleNavierStokesSPGSMStabilization
	Adds VMS-based stabilization to LowMachNavierStokes physics class. More...

class	IncompressibleNavierStokesStabilizationBase

class	IncompressibleNavierStokesStabilizationHelper

class	IncompressiblePlaneStressHyperelasticity

class	LowMachNavierStokes
	Physics class for Incompressible Navier-Stokes. More...

class	LowMachNavierStokesBase
	Physics class for Incompressible Navier-Stokes. More...

class	LowMachNavierStokesBCHandling
	Base class for reading and handling boundary conditions for physics classes. More...

class	LowMachNavierStokesBraackStabilization
	Adds VMS-based stabilization to LowMachNavierStokes physics class. More...

class	LowMachNavierStokesSPGSMStabilization
	Adds SPGSM-based stabilization to LowMachNavierStokes physics class. More...

class	LowMachNavierStokesStabilizationBase
	Adds VMS-based stabilization to LowMachNavierStokes physics class. More...

class	LowMachNavierStokesStabilizationHelper

class	LowMachNavierStokesVMSStabilization
	Adds VMS-based stabilization to LowMachNavierStokes physics class. More...

class	MeshAdaptiveSolverBase

class	MeshBuilder

class	MooneyRivlin

class	MultiphysicsSystem
	Interface with libMesh for solving Multiphysics problems. More...

class	NBCContainer
	Simple helper class to setup general Neumann boundary conditions. More...

class	NeumannFuncObj
	Base class for general, non-constant Neumann boundary conditions. More...

class	ParabolicProfile
	Parabolic profile. More...

class	ParameterManager
	Simple class to hold and initialize a ParameterVector. More...

class	ParameterUser
	ParameterUser base class. Utility methods for subclasses. More...

class	ParsedConductivity

class	ParsedInteriorQoI
	Parsed Interior QoI. More...

class	ParsedSourceTerm

class	ParsedVelocitySource
	Physics class for Velocity Penalty. More...

class	ParsedVelocitySourceAdjointStabilization
	Adds Velocity penalty adjoint stabilization source term. More...

class	ParsedVelocitySourceBase

class	ParsedViscosity

class	PBCContainer
	Simple helper class to setup periodic boundary conditions. More...

class	Physics
	Physics abstract base class. Defines API for physics to be added to MultiphysicsSystem. More...

class	PhysicsFactory
	Object for constructing list of physics for simulation. More...

class	PostProcessedQuantities

class	PostprocessingFactory
	This object handles constructing the postprocessing object to be used. More...

class	PowerLawCatalycity

class	PressurePinning
	Class to hold typical boundary condition methods. More...

class	PrimitiveFlowFEVariables

class	PrimitiveFlowVariables

class	PrimitiveTempFEVariables

class	PrimitiveTempVariables

class	QoIBase

class	QoIFactory

class	ReactingLowMachNavierStokes

class	ReactingLowMachNavierStokesBase

class	ReactingLowMachNavierStokesBCHandling

class	ScalarODE
	Physics class for arbitrary scalar-valued ODEs. More...

class	Simulation

class	SimulationBuilder

class	SolidMechanicsBCHandling

class	SolidMechanicsFEVariables

class	SolidMechanicsVariables

class	Solver

class	SolverContext
	Simple class to hold objects passed to Solver::solve. More...

class	SolverFactory
	This object handles constructing the solver to be used. More...

class	SourceTermBase
	Base class for generic source function term, f(x,y,z,t). More...

class	SpalartAllmaras
	Physics class for Incompressible Navier-Stokes. More...

class	SpalartAllmarasBCHandling
	Base class for reading and handling boundary conditions for physics classes. More...

class	SpalartAllmarasHelper

class	SpalartAllmarasParameters
	Encapsulate Spalart-Allmaras model parameters. More...

class	SpalartAllmarasSPGSMStabilization
	Adds SUPG stabilization to the SpalartAllmaras 'physics'. More...

class	SpalartAllmarasStabilizationBase

class	SpalartAllmarasStabilizationHelper

class	SpalartAllmarasViscosity

class	StabilizationHelper

class	SteadyMeshAdaptiveSolver

class	SteadySolver

class	SteadyVisualization

class	Stokes
	Physics class for Stokes. More...

class	StressStrainLaw

class	ThermallyDrivenFlowTestBCFactory

struct	thermo_type

class	TurbulenceFEVariables

class	TurbulenceModelsBase
	Physics class for Turbulence Models. More...

class	TurbulenceVariables

class	UnsteadySolver

class	UnsteadyVisualization

class	VelocityDrag
	Physics class for Velocity Drag. More...

class	VelocityDragAdjointStabilization
	Physics class for Velocity Drag. More...

class	VelocityDragBase

class	VelocityPenalty
	Physics class for Velocity Penalty. More...

class	VelocityPenaltyAdjointStabilization
	Adds Velocity penalty adjoint stabilization source term. More...

class	VelocityPenaltyBase

struct	viscosity_type

class	Visualization

class	VisualizationFactory

class	Vorticity
	Vorticity QoI. More...

class	ZeroFluxBC

Typedefs
typedef int	BCType

typedef std::string	PhysicsName

typedef unsigned int	VariableIndex
	More descriptive name of the type used for variable indices. More...

typedef std::string	VariableName

typedef libMesh::boundary_id_type	BoundaryID
	More descriptive name of the type used for boundary ids. More...

typedef std::map< std::string, std::tr1::shared_ptr< GRINS::Physics > >	PhysicsList
	Container for GRINS::Physics object pointers. More...

typedef std::map< std::string, std::tr1::shared_ptr< GRINS::Physics > >::const_iterator	PhysicsListIter
	Iterator for PhysicsList. More...

typedef PhysicsFactory::PhysicsPtr	PhysicsPtr

Functions
void	visc_cond_specheat_error (const std::string &physics, const std::string &conductivity, const std::string &viscosity, const std::string &specific_heat)

void	visc_error (const std::string &physics, const std::string &viscosity)

void	conductivity_error (const std::string &physics, const std::string &conductivity)

template<template< typename > class Subclass>
PhysicsPtr	new_mu_class (const std::string &physics_to_add, const GetPot &input)

template<>
PhysicsPtr	new_mu_class< SpalartAllmaras > (const std::string &physics_to_add, const GetPot &input)

template<template< typename > class Subclass>
PhysicsPtr	new_turb_mu_class (const std::string &physics_to_add, const GetPot &input)

template<template< typename > class Subclass>
PhysicsPtr	new_k_class (const std::string &physics_to_add, const GetPot &input)

template<template< typename, typename, typename > class Subclass>
PhysicsPtr	new_mu_cp_k_class (const std::string &physics_to_add, const GetPot &input)

template<template< typename, typename > class Subclass>
PhysicsPtr	new_reacting_low_mach_class (const std::string &physics_to_add, const GetPot &input)

void	grins_version_stdout ()

int	get_grins_version ()

void	skip_comment_lines (std::istream &in, const char comment_start)
	Skip comment lines in the header of an ASCII text file prefixed with the comment character 'comment_start'. More...

Variables
const PhysicsName	stokes = "Stokes"

const PhysicsName	incompressible_navier_stokes = "IncompressibleNavierStokes"

const PhysicsName	incompressible_navier_stokes_adjoint_stab

const PhysicsName	incompressible_navier_stokes_spgsm_stab

const PhysicsName	velocity_drag = "VelocityDrag"

const PhysicsName	velocity_drag_adjoint_stab = "VelocityDragAdjointStabilization"

const PhysicsName	velocity_penalty = "VelocityPenalty"

const PhysicsName	velocity_penalty2 = "VelocityPenalty2"

const PhysicsName	velocity_penalty3 = "VelocityPenalty3"

const PhysicsName	velocity_penalty_adjoint_stab = "VelocityPenaltyAdjointStabilization"

const PhysicsName	velocity_penalty2_adjoint_stab = "VelocityPenalty2AdjointStabilization"

const PhysicsName	velocity_penalty3_adjoint_stab = "VelocityPenalty3AdjointStabilization"

const PhysicsName	parsed_velocity_source = "ParsedVelocitySource"

const PhysicsName	parsed_velocity_source_adjoint_stab = "ParsedVelocitySourceAdjointStabilization"

const PhysicsName	averaged_fan = "AveragedFan"

const PhysicsName	averaged_fan_adjoint_stab = "AveragedFanAdjointStabilization"

const PhysicsName	averaged_turbine = "AveragedTurbine"

const PhysicsName	spalart_allmaras = "SpalartAllmaras"

const PhysicsName	spalart_allmaras_spgsm_stab = "SpalartAllmarasSPGSMStabilization"

const PhysicsName	scalar_ode = "ScalarODE"

const PhysicsName	heat_conduction = "HeatConduction"

const PhysicsName	heat_transfer = "HeatTransfer"

const PhysicsName	heat_transfer_source = "HeatTransferSource"

const PhysicsName	heat_transfer_adjoint_stab = "HeatTransferAdjointStabilization"

const PhysicsName	heat_transfer_spgsm_stab = "HeatTransferSPGSMStabilization"

const PhysicsName	axisymmetric_heat_transfer = "AxisymmetricHeatTransfer"

const PhysicsName	boussinesq_buoyancy = "BoussinesqBuoyancy"

const PhysicsName	boussinesq_buoyancy_adjoint_stab = "BoussinesqBuoyancyAdjointStabilization"

const PhysicsName	boussinesq_buoyancy_spgsm_stab = "BoussinesqBuoyancySPGSMStabilization"

const PhysicsName	axisymmetric_boussinesq_buoyancy = "AxisymmetricBoussinesqBuoyancy"

const PhysicsName	low_mach_navier_stokes = "LowMachNavierStokes"

const PhysicsName	low_mach_navier_stokes_braack_stab = "LowMachNavierStokesBraackStabilization"

const PhysicsName	low_mach_navier_stokes_spgsm_stab = "LowMachNavierStokesSPGSMStabilization"

const PhysicsName	low_mach_navier_stokes_vms_stab = "LowMachNavierStokesVMSStabilization"

const PhysicsName	reacting_low_mach_navier_stokes = "ReactingLowMachNavierStokes"

const PhysicsName	elastic_membrane = "ElasticMembrane"

const PhysicsName	elastic_cable = "ElasticCable"

const PhysicsName	elastic_membrane_constant_pressure = "ElasticMembraneConstantPressure"

const PhysicsName	elastic_cable_constant_gravity = "ElasticCableConstantGravity"

const PhysicsName	constant_source_term = "ConstantSourceTerm"

const PhysicsName	parsed_source_term = "ParsedSourceTerm"

const unsigned int	invalid_var_index = std::numeric_limits<unsigned int>::max()
	Invalid varaible index id. More...

const std::string	u_var_name_default = "u"
	Default physics variable names. More...

const std::string	v_var_name_default = "v"
	y-velocity More...

const std::string	w_var_name_default = "w"
	z-velocity More...

const std::string	nu_var_name_default = "nu"
	z-velocity More...

const std::string	u_r_var_name_default = "r_vel"
	r-velocity (axisymmetric case) More...

const std::string	u_z_var_name_default = "z_vel"
	z-velocity (axisymmetric case) More...

const std::string	p_var_name_default = "p"
	pressure More...

const std::string	T_var_name_default = "T"
	temperature More...

const std::string	fan_speed_var_name_default = "fan_speed"
	fan speed More...

const std::string	scalar_ode_var_name_default = "scalar_var"
	arbitrary scalar ODE variable name More...

const std::string	Ex_var_name_default = "Ex"
	Ex field. More...

const std::string	Ey_var_name_default = "Ey"
	Ey field. More...

const std::string	Ez_var_name_default = "Ez"
	Ez field. More...

const std::string	Bx_var_name_default = "Bx"
	Bx field. More...

const std::string	By_var_name_default = "By"
	By field. More...

const std::string	Bz_var_name_default = "Bz"
	Bz field. More...

const std::string	u_disp_name_default = "u"

const std::string	v_disp_name_default = "v"

const std::string	w_disp_name_default = "w"

const std::string	avg_nusselt = "average_nusselt_number"

const std::string	vorticity = "vorticity"

const std::string	parsed_interior = "parsed_interior"

Detailed Description

GRINS namespace.

Typedef Documentation

typedef int GRINS::BCType

Definition at line 32 of file bc_types.h.

typedef libMesh::boundary_id_type GRINS::BoundaryID

More descriptive name of the type used for boundary ids.

We make it a short int to be compatible with libMesh

Definition at line 54 of file var_typedefs.h.

typedef std::map< std::string,std::tr1::shared_ptr<GRINS::Physics> > GRINS::PhysicsList

Container for GRINS::Physics object pointers.

Definition at line 57 of file var_typedefs.h.

typedef std::map< std::string,std::tr1::shared_ptr<GRINS::Physics> >::const_iterator GRINS::PhysicsListIter

Iterator for PhysicsList.

Definition at line 60 of file var_typedefs.h.

typedef std::string GRINS::PhysicsName

Definition at line 33 of file grins_physics_names.h.

typedef PhysicsFactory::PhysicsPtr GRINS::PhysicsPtr

Definition at line 103 of file physics_factory.C.

typedef unsigned int GRINS::VariableIndex

More descriptive name of the type used for variable indices.

Definition at line 40 of file var_typedefs.h.

typedef std::string GRINS::VariableName

Definition at line 50 of file var_typedefs.h.

Function Documentation

void GRINS::conductivity_error	(	const std::string &	physics,
		const std::string &	conductivity
	)

Definition at line 129 of file physics_factory.C.

Referenced by new_k_class().

   {
     std::cerr << "================================================================" << std::endl
               << "Invalid combination of models for " << physics << std::endl
               << "Conductivity model     = " << conductivity << std::endl
               << "================================================================" << std::endl;
     libmesh_error();
   }

int GRINS::get_grins_version ( )

Definition at line 51 of file grins_version.C.

References GRINS_MAJOR_VERSION, GRINS_MICRO_VERSION, and GRINS_MINOR_VERSION.

Referenced by grins_version_stdout().

   {
     /* Note: return format follows the versioning convention xx.yy.zz where
    
        xx = major version number
        yy = minor version number
        zz = micro version number
      
        For example:
        v.   0.23  -> 002300 = 2300
        v   0.23.1 -> 002301 = 2301
        v. 10.23.2 -> 102302         */
 
     int major_version = 0;
     int minor_version = 0;
     int micro_version = 0;
 
 #ifdef GRINS_MAJOR_VERSION
     major_version = GRINS_MAJOR_VERSION;
 #endif
 
 #ifdef GRINS_MINOR_VERSION
     minor_version = GRINS_MINOR_VERSION;
 #endif
 
 #ifdef GRINS_MICRO_VERSION
     micro_version = GRINS_MICRO_VERSION;
 #endif
       
     return major_version*10000 + minor_version*100 + micro_version;
   }

void GRINS::grins_version_stdout ( )

Definition at line 31 of file grins_version.C.

References get_grins_version(), GRINS_BUILD_ARCH, GRINS_BUILD_DATE, GRINS_BUILD_HOST, GRINS_BUILD_USER, GRINS_BUILD_VERSION, GRINS_CXX, GRINS_CXXFLAGS, GRINS_LIB_RELEASE, and GRINS_LIB_VERSION.

Referenced by main().

   {
     std::cout << "--------------------------------------------------------" << std::endl;
     std::cout << "GRINS Package: Version = " << GRINS_LIB_VERSION;
     std::cout << " (" << get_grins_version() << ")" << std::endl << std::endl;
   
     std::cout << GRINS_LIB_RELEASE << std::endl << std::endl;
   
     std::cout << "Build Date   = " << GRINS_BUILD_DATE     << std::endl;
     std::cout << "Build Host   = " << GRINS_BUILD_HOST     << std::endl;
     std::cout << "Build User   = " << GRINS_BUILD_USER     << std::endl;
     std::cout << "Build Arch   = " << GRINS_BUILD_ARCH     << std::endl;
     std::cout << "Build Rev    = " << GRINS_BUILD_VERSION  << std::endl << std::endl;
   
     std::cout << "C++ Config   = " << GRINS_CXX << " " << GRINS_CXXFLAGS << std::endl;
     std::cout << "--------------------------------------------------------" << std::endl;
   
     return;
   }

template<template< typename > class Subclass>

PhysicsPtr GRINS::new_k_class	(	const std::string &	physics_to_add,
		const GetPot &	input
	)

Definition at line 202 of file physics_factory.C.

References conductivity_error(), and heat_transfer.

   {
     std::string conductivity =
       input( "Physics/"+heat_transfer+"/conductivity_model", "constant" );
 
     if( conductivity == "constant" )
       return PhysicsPtr
         (new Subclass<ConstantConductivity>(physics_to_add,input));
     else if( conductivity == "parsed" )
       return PhysicsPtr
         (new Subclass<ParsedConductivity>(physics_to_add,input));
 
     conductivity_error(physics_to_add, conductivity);
     return PhysicsPtr();
   }

template<template< typename > class Subclass>

PhysicsPtr GRINS::new_mu_class	(	const std::string &	physics_to_add,
		const GetPot &	input
	)

Definition at line 148 of file physics_factory.C.

References incompressible_navier_stokes, and visc_error().

   {
     std::string viscosity =
       input( "Physics/"+incompressible_navier_stokes+"/viscosity_model", "constant" );
 
     if( viscosity == "constant" )
       return PhysicsPtr
         (new Subclass<ConstantViscosity>(physics_to_add,input));
     else if( viscosity == "parsed" )
       return PhysicsPtr
         (new Subclass<ParsedViscosity>(physics_to_add,input));
     else if( viscosity == "spalartallmaras" )
       return PhysicsPtr
         (new Subclass<SpalartAllmarasViscosity<ConstantViscosity> >(physics_to_add,input));
 
     visc_error(physics_to_add, viscosity);
     return PhysicsPtr();
   }

template<>

PhysicsPtr GRINS::new_mu_class< SpalartAllmaras >	(	const std::string &	physics_to_add,
		const GetPot &	input
	)

Definition at line 171 of file physics_factory.C.

References incompressible_navier_stokes, and visc_error().

Referenced by GRINS::PhysicsFactory::add_physics().

   {
     std::string viscosity =
       input( "Physics/"+incompressible_navier_stokes+"/viscosity_model", "constant" );
 
     if( viscosity == "spalartallmaras" )
       return PhysicsPtr
         (new SpalartAllmaras<ConstantViscosity>(physics_to_add,input));
 
     visc_error(physics_to_add, viscosity);
     return PhysicsPtr();
   }

template<template< typename, typename, typename > class Subclass>

PhysicsPtr GRINS::new_mu_cp_k_class	(	const std::string &	physics_to_add,
		const GetPot &	input
	)

Definition at line 220 of file physics_factory.C.

References low_mach_navier_stokes, and visc_cond_specheat_error().

   {
     std::string conductivity  = input( "Physics/"+low_mach_navier_stokes+"/conductivity_model", "constant" );
     std::string viscosity     = input( "Physics/"+low_mach_navier_stokes+"/viscosity_model", "constant" );
     std::string specific_heat = input( "Physics/"+low_mach_navier_stokes+"/specific_heat_model", "constant" );
 
     if(  conductivity == "constant" && viscosity == "constant" && specific_heat == "constant" )
       {
         return PhysicsPtr
           (new Subclass<ConstantViscosity,
                         ConstantSpecificHeat,
                         ConstantConductivity>
              (physics_to_add,input));
       }
 
     visc_cond_specheat_error(physics_to_add, conductivity,
                              viscosity, specific_heat);
     return PhysicsPtr();
   }

template<template< typename, typename > class Subclass>

PhysicsPtr GRINS::new_reacting_low_mach_class	(	const std::string &	physics_to_add,
		const GetPot &	input
	)

Definition at line 242 of file physics_factory.C.

References reacting_low_mach_navier_stokes.

   {
     std::string thermochem_lib = input( "Physics/"+reacting_low_mach_navier_stokes+"/thermochemistry_library", "DIE!" );
 
     if( thermochem_lib == "cantera" )
       {
 #ifdef GRINS_HAVE_CANTERA
         return PhysicsPtr(new Subclass<CanteraMixture,CanteraEvaluator>(physics_to_add,input));
 #else
         std::cerr << "Error: Cantera not enabled. Cannot use Cantera library."
                   << std::endl;
         libmesh_error();
 
 #endif // GRINS_HAVE_CANTERA
       }
     else if( thermochem_lib == "antioch" )
       {
 #ifdef GRINS_HAVE_ANTIOCH
         std::string mixing_model = input( "Physics/Antioch/mixing_model" , "wilke" );
 
         std::string thermo_model = input( "Physics/Antioch/thermo_model", "stat_mech");
         std::string viscosity_model = input( "Physics/Antioch/viscosity_model", "blottner");
         std::string conductivity_model = input( "Physics/Antioch/conductivity_model", "eucken");
         std::string diffusivity_model = input( "Physics/Antioch/diffusivity_model", "constant_lewis");
 
         if( mixing_model == std::string("wilke") )
           {
             if( (thermo_model == std::string("stat_mech")) &&
                 (diffusivity_model == std::string("constant_lewis")) &&
                 (conductivity_model == std::string("eucken")) &&
                 (viscosity_model == std::string("sutherland")) )
               {
                 return PhysicsPtr(new Subclass<GRINS::AntiochWilkeTransportMixture<Antioch::StatMechThermodynamics<libMesh::Real>,
                                                                                    Antioch::MixtureViscosity<Antioch::SutherlandViscosity<libMesh::Real> >,
                                                                                    Antioch::EuckenThermalConductivity<Antioch::StatMechThermodynamics<libMesh::Real> >,
                                                                                    Antioch::ConstantLewisDiffusivity<libMesh::Real> >,
                                                GRINS::AntiochWilkeTransportEvaluator<Antioch::StatMechThermodynamics<libMesh::Real>,
                                                                                      Antioch::MixtureViscosity<Antioch::SutherlandViscosity<libMesh::Real> >,
                                                                                      Antioch::EuckenThermalConductivity<Antioch::StatMechThermodynamics<libMesh::Real> >,
                                                                                      Antioch::ConstantLewisDiffusivity<libMesh::Real> > >(physics_to_add,input) );
               }
             else if( (thermo_model == std::string("stat_mech")) &&
                      (diffusivity_model == std::string("constant_lewis")) &&
                      (conductivity_model == std::string("eucken")) &&
                      (viscosity_model == std::string("blottner")) )
               {
                 return PhysicsPtr(new Subclass<GRINS::AntiochWilkeTransportMixture<Antioch::StatMechThermodynamics<libMesh::Real>,
                                                                                    Antioch::MixtureViscosity<Antioch::BlottnerViscosity<libMesh::Real> >,
                                                                                    Antioch::EuckenThermalConductivity<Antioch::StatMechThermodynamics<libMesh::Real> >,
                                                                                    Antioch::ConstantLewisDiffusivity<libMesh::Real> >,
                                                GRINS::AntiochWilkeTransportEvaluator<Antioch::StatMechThermodynamics<libMesh::Real>,
                                                                                      Antioch::MixtureViscosity<Antioch::BlottnerViscosity<libMesh::Real> >,
                                                                                      Antioch::EuckenThermalConductivity<Antioch::StatMechThermodynamics<libMesh::Real> >,
                                                                                      Antioch::ConstantLewisDiffusivity<libMesh::Real> > >(physics_to_add,input) );
               }
             else
               {
                             std::cerr << "Error: Unknown Antioch model combination: "
                                       << "viscosity_model    = " << viscosity_model << std::endl
                                       << "conductivity_model = " << conductivity_model << std::endl
                                       << "diffusivity_model  = " << diffusivity_model << std::endl
                                       << "thermo_model       = " << thermo_model << std::endl;
                             libmesh_error();
               }
           }
         else if( mixing_model == std::string("constant") )
           {
             if( viscosity_model != std::string("constant") )
               {
                 std::cerr << "Error: For constant mixing_model, viscosity model must be constant!"
                           << std::endl;
                 libmesh_error();
               }
 
             if( diffusivity_model != std::string("constant_lewis") )
               {
                 std::cerr << "Error: For constant mixing_model, diffusivity model must be constant_lewis!"
                           << std::endl;
                 libmesh_error();
               }
 
             if( (thermo_model == std::string("stat_mech")) &&
                 (conductivity_model == std::string("constant")) )
               {
                 return PhysicsPtr(new Subclass<GRINS::AntiochConstantTransportMixture<GRINS::ConstantConductivity>,
                                                GRINS::AntiochConstantTransportEvaluator<Antioch::StatMechThermodynamics<libMesh::Real>, GRINS::ConstantConductivity> >(physics_to_add,input) );
               }
             else if( (thermo_model == std::string("cea")) &&
                      (conductivity_model == std::string("constant")) )
               {
                 return PhysicsPtr(new Subclass<GRINS::AntiochConstantTransportMixture<GRINS::ConstantConductivity>,
                                                GRINS::AntiochConstantTransportEvaluator<Antioch::CEAEvaluator<libMesh::Real>, GRINS::ConstantConductivity> >(physics_to_add,input) );
               }
             else if( (thermo_model == std::string("stat_mech")) &&
                 (conductivity_model == std::string("constant_prandtl")) )
               {
                 return PhysicsPtr(new Subclass<GRINS::AntiochConstantTransportMixture<GRINS::ConstantPrandtlConductivity>,
                                                GRINS::AntiochConstantTransportEvaluator<Antioch::StatMechThermodynamics<libMesh::Real>, GRINS::ConstantPrandtlConductivity> >(physics_to_add,input) );
               }
             else if( (thermo_model == std::string("cea")) &&
                      (conductivity_model == std::string("constant_prandtl")) )
               {
                 return PhysicsPtr(new Subclass<GRINS::AntiochConstantTransportMixture<GRINS::ConstantPrandtlConductivity>,
                                                GRINS::AntiochConstantTransportEvaluator<Antioch::CEAEvaluator<libMesh::Real>, GRINS::ConstantPrandtlConductivity> >(physics_to_add,input) );
               }
             else
               {
                 std::cerr << "Error: Unknown Antioch model combination: "
                           << "viscosity_model    = " << viscosity_model << std::endl
                           << "conductivity_model = " << conductivity_model << std::endl
                           << "diffusivity_model  = " << diffusivity_model << std::endl
                           << "thermo_model       = " << thermo_model << std::endl;
                 libmesh_error();
               }
           }
         else // mixing_model
           {
             std::cerr << "Error: Unknown Antioch mixing_model "
                       << mixing_model << "!" << std::endl;
             libmesh_error();
           }
 #else
         std::cerr << "Error: Antioch not enabled. Cannot use Antioch library."
                   << std::endl;
         libmesh_error();
 
 #endif // GRINS_HAVE_ANTIOCH
       }
     else
       {
         std::cerr << "Error: Invalid thermo-chemistry library" << std::endl
                   << "       for ReactingLowMachNavierStokes physics." << std::endl
                   << "       thermochemistry_library = " << thermochem_lib << std::endl;
         libmesh_error();
       }
 
     return PhysicsPtr();
   }

template<template< typename > class Subclass>

PhysicsPtr GRINS::new_turb_mu_class	(	const std::string &	physics_to_add,
		const GetPot &	input
	)

Definition at line 187 of file physics_factory.C.

References incompressible_navier_stokes, and visc_error().

   {
     std::string viscosity =
       input( "Physics/"+incompressible_navier_stokes+"/viscosity_model", "constant" );
 
     if( viscosity == "spalartallmaras" )
       return PhysicsPtr
         (new Subclass<SpalartAllmarasViscosity<ConstantViscosity> >(physics_to_add,input));
 
     visc_error(physics_to_add, viscosity);
     return PhysicsPtr();
   }

void GRINS::skip_comment_lines	(	std::istream &	in,
		const char	comment_start
	)

Skip comment lines in the header of an ASCII text file prefixed with the comment character 'comment_start'.

This is put in GRINS namespace so we can reuse in a few classes where we are reading in text tables. Originally taken from FIN-S.

Definition at line 30 of file input_utils.C.

   {
     char c, line[256];
     
     while (in.get(c), c==comment_start) 
       in.getline (line, 255);
     
     // put back first character of
     // first non-comment line
     in.putback (c);
   }

void GRINS::visc_cond_specheat_error	(	const std::string &	physics,
		const std::string &	conductivity,
		const std::string &	viscosity,
		const std::string &	specific_heat
	)

Definition at line 105 of file physics_factory.C.

Referenced by new_mu_cp_k_class().

   {
     std::cerr << "================================================================" << std::endl
               << "Invalid combination of models for " << physics << std::endl
               << "Conductivity model  = " << conductivity << std::endl
               << "Viscosity model     = " << viscosity << std::endl
               << "Specific heat model = " << specific_heat << std::endl
               << "================================================================" << std::endl;
     libmesh_error();
   }

void GRINS::visc_error	(	const std::string &	physics,
		const std::string &	viscosity
	)

Definition at line 119 of file physics_factory.C.

Referenced by new_mu_class(), new_mu_class< SpalartAllmaras >(), and new_turb_mu_class().

   {
     std::cerr << "================================================================" << std::endl
               << "Invalid combination of models for " << physics << std::endl
               << "Viscosity model     = " << viscosity << std::endl
               << "================================================================" << std::endl;
     libmesh_error();
   }

Variable Documentation

const PhysicsName GRINS::averaged_fan = "AveragedFan"

Definition at line 51 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics(), and GRINS::AveragedFanBase< Viscosity >::read_input_options().

const PhysicsName GRINS::averaged_fan_adjoint_stab = "AveragedFanAdjointStabilization"

Definition at line 52 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics().

const PhysicsName GRINS::averaged_turbine = "AveragedTurbine"

Definition at line 53 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics(), and GRINS::AveragedTurbineBase< Viscosity >::read_input_options().

const std::string GRINS::avg_nusselt = "average_nusselt_number"

Definition at line 30 of file qoi_names.h.

Referenced by GRINS::QoIFactory::add_qoi(), and GRINS::QoIFactory::check_qoi_physics_consistency().

const PhysicsName GRINS::axisymmetric_boussinesq_buoyancy = "AxisymmetricBoussinesqBuoyancy"

Definition at line 66 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics(), GRINS::PhysicsFactory::check_physics_consistency(), and GRINS::AxisymmetricBoussinesqBuoyancy::read_input_options().

const PhysicsName GRINS::axisymmetric_heat_transfer = "AxisymmetricHeatTransfer"

Definition at line 62 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics(), GRINS::PhysicsFactory::check_physics_consistency(), GRINS::AxisymmetricHeatTransfer< Conductivity >::read_input_options(), and GRINS::AxisymmetricBoussinesqBuoyancy::read_input_options().

const PhysicsName GRINS::boussinesq_buoyancy = "BoussinesqBuoyancy"

Definition at line 63 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics(), GRINS::BoussinesqBuoyancyBase::BoussinesqBuoyancyBase(), and GRINS::PhysicsFactory::check_physics_consistency().

const PhysicsName GRINS::boussinesq_buoyancy_adjoint_stab = "BoussinesqBuoyancyAdjointStabilization"

Definition at line 64 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics(), and GRINS::PhysicsFactory::check_physics_consistency().

const PhysicsName GRINS::boussinesq_buoyancy_spgsm_stab = "BoussinesqBuoyancySPGSMStabilization"

Definition at line 65 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics().

const std::string GRINS::Bx_var_name_default = "Bx"

Bx field.

Definition at line 81 of file variable_name_defaults.h.

const std::string GRINS::By_var_name_default = "By"

By field.

Definition at line 84 of file variable_name_defaults.h.

const std::string GRINS::Bz_var_name_default = "Bz"

Bz field.

Definition at line 87 of file variable_name_defaults.h.

const PhysicsName GRINS::constant_source_term = "ConstantSourceTerm"

Definition at line 76 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics().

const PhysicsName GRINS::elastic_cable = "ElasticCable"

Definition at line 73 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics(), and GRINS::ElasticCable< StressStrainLaw >::register_postprocessing_vars().

const PhysicsName GRINS::elastic_cable_constant_gravity = "ElasticCableConstantGravity"

Definition at line 75 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics().

const PhysicsName GRINS::elastic_membrane = "ElasticMembrane"

Definition at line 72 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics(), and GRINS::ElasticMembrane< StressStrainLaw >::register_postprocessing_vars().

const PhysicsName GRINS::elastic_membrane_constant_pressure = "ElasticMembraneConstantPressure"

Definition at line 74 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics().

const std::string GRINS::Ex_var_name_default = "Ex"

Ex field.

Definition at line 72 of file variable_name_defaults.h.

const std::string GRINS::Ey_var_name_default = "Ey"

Ey field.

Definition at line 75 of file variable_name_defaults.h.

const std::string GRINS::Ez_var_name_default = "Ez"

Ez field.

Definition at line 78 of file variable_name_defaults.h.

const std::string GRINS::fan_speed_var_name_default = "fan_speed"

fan speed

Definition at line 66 of file variable_name_defaults.h.

Referenced by GRINS::AveragedTurbineBase< Viscosity >::read_input_options().

const PhysicsName GRINS::heat_conduction = "HeatConduction"

Definition at line 57 of file grins_physics_names.h.

Referenced by GRINS::HeatConduction< Conductivity >::HeatConduction().

const PhysicsName GRINS::heat_transfer = "HeatTransfer"

Definition at line 58 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics(), GRINS::BoussinesqBuoyancySPGSMStabilization< Viscosity >::BoussinesqBuoyancySPGSMStabilization(), GRINS::PhysicsFactory::check_physics_consistency(), GRINS::QoIFactory::check_qoi_physics_consistency(), GRINS::HeatTransferBase< Conductivity >::HeatTransferBase(), new_k_class(), and GRINS::HeatTransfer< Conductivity >::register_postprocessing_vars().

const PhysicsName GRINS::heat_transfer_adjoint_stab = "HeatTransferAdjointStabilization"

Definition at line 60 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics(), and GRINS::PhysicsFactory::check_physics_consistency().

const PhysicsName GRINS::heat_transfer_source = "HeatTransferSource"

Definition at line 59 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics(), and GRINS::PhysicsFactory::check_physics_consistency().

const PhysicsName GRINS::heat_transfer_spgsm_stab = "HeatTransferSPGSMStabilization"

Definition at line 61 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics().

const PhysicsName GRINS::incompressible_navier_stokes = "IncompressibleNavierStokes"

Definition at line 36 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics(), GRINS::AveragedFanAdjointStabilization< Viscosity >::AveragedFanAdjointStabilization(), GRINS::AveragedTurbineAdjointStabilization< Viscosity >::AveragedTurbineAdjointStabilization(), GRINS::BoussinesqBuoyancyAdjointStabilization< Viscosity >::BoussinesqBuoyancyAdjointStabilization(), GRINS::BoussinesqBuoyancySPGSMStabilization< Viscosity >::BoussinesqBuoyancySPGSMStabilization(), AxiParabolicBCFactory::build_dirichlet(), ParabolicBCFactory::build_dirichlet(), AxiConCylBCFactory::build_dirichlet(), TurbulentBCFactory::build_dirichlet(), GRINS::PhysicsFactory::check_physics_consistency(), GRINS::ConstantConductivity::ConstantConductivity(), GRINS::ConstantViscosity::ConstantViscosity(), new_mu_class(), new_mu_class< SpalartAllmaras >(), new_turb_mu_class(), GRINS::IncompressibleNavierStokes< Viscosity >::read_input_options(), GRINS::AxisymmetricHeatTransfer< Conductivity >::read_input_options(), GRINS::AxisymmetricBoussinesqBuoyancy::read_input_options(), GRINS::IncompressibleNavierStokes< Viscosity >::register_postprocessing_vars(), and GRINS::VelocityDragAdjointStabilization< Viscosity >::VelocityDragAdjointStabilization().

const PhysicsName GRINS::incompressible_navier_stokes_adjoint_stab

Initial value:

=

"IncompressibleNavierStokesAdjointStabilization"

Definition at line 37 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics(), and GRINS::PhysicsFactory::check_physics_consistency().

const PhysicsName GRINS::incompressible_navier_stokes_spgsm_stab

Initial value:

=

"IncompressibleNavierStokesSPGSMStabilization"

Definition at line 39 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics(), and GRINS::PhysicsFactory::check_physics_consistency().

const unsigned int GRINS::invalid_var_index = std::numeric_limits<unsigned int>::max()

Invalid varaible index id.

We can't use negative values, so we use the max to be able to initialize VariableIndex quantities since we're much more unlikely to hit the max than 0.

Definition at line 48 of file var_typedefs.h.

const PhysicsName GRINS::low_mach_navier_stokes = "LowMachNavierStokes"

Definition at line 67 of file grins_physics_names.h.

Referenced by GRINS::PhysicsFactory::add_physics(), GRINS::PhysicsFactory::check_physics_consistency(), GRINS::QoIFactory::check_qoi_physics_consistency(), new_mu_cp_k_class(), GRINS::LowMachNavierStokes< Viscosity, SpecificHeat, ThermalConductivity >::read_input_options(), GRINS::LowMachNavierStokesBase< Viscosity, SpecificHeat, ThermalConductivity >::read_input_options(), and GRINS::LowMachNavierStokes< Viscosity, SpecificHeat, ThermalConductivity >::register_postprocessing_vars().