GRINS Namespace Reference

GRINS namespace. More...

Namespaces
	Cache
	Constants
	GRINSPrivate
	Not intended for users as a public API.
	StringUtilities

Classes
class	AbsorptionCoeff
	Evaluates the Beer-Lambert Law at a given point in space. More...
class	AdaptiveTimeSteppingOptions
	Container for adaptive time-stepping options. More...
class	AdjointErrorEstimatorFactoryBase
class	AdjointRefinementErrorEstimatorFactory
class	AdjointResidualErrorEstimatorFactory
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	AntiochConstantTransportMixtureBuilder
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	AntiochMixtureAveragedTransportEvaluator
	Wrapper class for evaluating Wilke transport properties using Antioch. More...
class	AntiochMixtureAveragedTransportMixture
	Wrapper class for storing state for computing Wilke transport properties using Antioch. More...
class	AntiochMixtureAveragedTransportMixtureBuilder
class	AntiochMixtureBuilderBase
	Base class building Antioch mixture wrappers. More...
class	AntiochOptions
class	ArrheniusCatalycity
class	ArrheniusCatalycityFactory
class	ArrheniusCatalycityFactoryOldStyle
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	AxisymmetryBCFactory
	r-coordinate is assumed to be the x-coordinate in the axisymmetric case, so we need to pin the x-coordinate. More...
class	BCBuilder
	Manages runtime construction of Dirichlet boundary conditions. More...
class	BCFactoryAbstract
class	BoundaryConditionFactoryInitializer
	Initialize all Factory objects related to boundary conditions. More...
class	BoundaryConditionNames
	Class to contain names of sections and types of boundary conditions. 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	BuilderHelper
	This class contains common functions used by various Builders throughout GRINS. 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	CatalycityFactoryAbstract
class	CatalycityFactoryOldStyleBase
class	CatalyticWallBase
class	CatalyticWallNeumannBCFactoryBase
class	CatalyticWallNeumannBCFactoryCommon
	Factory helper class for building catalytic wall Neumann boundary conditions. More...
class	CatalyticWallNeumannBCOldStyleFactoryBase
class	ChemistryBuilder
class	CompositeParsedFEMNeumannBC
class	CompositeParsedNeumannBC
class	CompositeQoI
class	ComputeDistanceJacobian
class	ComputeDistanceResidual
struct	conductivity_type
class	ConstantCatalycity
class	ConstantCatalycityFactory
class	ConstantCatalycityFactoryOldStyle
class	ConstantConductivity
class	ConstantFunctionDirichletBCFactory
	Constructs ConstFunction objects for Dirichlet boundary conditions. More...
class	ConstantPrandtlConductivity
class	ConstantSourceFunction
class	ConstantSourceTerm
class	ConstantSpecificHeat
class	ConstantViscosity
class	ConstrainedPoints
	Manages construction of Constraint application object. More...
class	ConstraintBuilder
	Manages construction of Constraint application object. More...
class	ConvectionDiffusion
class	DefaultBCBuilder
	Manages runtime construction of Dirichlet boundary conditions. More...
class	DefaultVariableBuilder
struct	diffusivity_type
class	DirichletBCFactoryAbstract
class	DirichletBCFactoryFunctionBase
class	DirichletBCFactoryFunctionOldStyleBase
class	DisplacementVariable
class	DistanceFunction
class	ElasticCable
class	ElasticCableAbstract
class	ElasticCableBase
class	ElasticCableRayleighDamping
class	ElasticityTensor
class	ElasticMembrane
class	ElasticMembraneAbstract
class	ElasticMembraneBase
class	ElasticMembraneConstantPressure
class	ElasticMembraneRayleighDamping
class	ErrorEstimatorFactoryBase
	Builds VariableBase objects. More...
class	ErrorEstimatorFactoryBasic
class	ErrorEstimatorFactoryInitializer
	Initialize all ErrorEstimatorFactory objects. More...
class	ErrorEstimatorOptions
	Container for ErrorEstimator options. More...
class	FactoryAbstract
	Abstract factory. More...
class	FactoryWithGetPot
	Abstract factory that provides availability of GetPot. More...
class	FactoryWithGetPotPhysicsName
	Abstract factory that provides availability of GetPot and a physics_name. More...
class	FEMFunctionAndDerivativeBase
	Extends libMesh::FEMFunctionBase by adding a function for computing derivatives. More...
class	FEVariablesBase
class	GasMixture
class	GasRecombinationCatalyticWall
class	GasRecombinationCatalyticWallNeumannBCFactory
class	GasRecombinationCatalyticWallNeumannBCFactoryImpl
class	GasRecombinationCatalyticWallNeumannBCOldStyleFactory
class	GasSolidCatalyticWall
class	GasSolidCatalyticWallNeumannBCFactory
class	GasSolidCatalyticWallNeumannBCFactoryImpl
class	GasSolidCatalyticWallNeumannBCOldStyleFactory
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	HeatTransferSPGSMStabilization
	Adds VMS-based stabilization to LowMachNavierStokes physics class. More...
class	HeatTransferStabilizationBase
class	HeatTransferStabilizationHelper
class	HITRAN
	HITRAN interface object. More...
class	HomogeneousDirichletBCFactory
class	HomogeneousNeumannBCFactory
	Generic factory for homogeneous Neumann boundary conditions. More...
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	IncompressibleNavierStokesSPGSMStabilization
	Adds VMS-based stabilization to LowMachNavierStokes physics class. More...
class	IncompressibleNavierStokesStabilizationBase
class	IncompressibleNavierStokesStabilizationHelper
class	IncompressiblePlaneStressHyperelasticity
class	IntegratedFunction
	IntegratedFunction. More...
class	IsothermalDirichletOldStyleBCFactory
class	LowMachNavierStokes
	Physics class for Incompressible Navier-Stokes. More...
class	LowMachNavierStokesBase
	Physics class for Incompressible Navier-Stokes. 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	MaterialsParsing
	Helper functions for parsing material properties. More...
class	MeshAdaptiveSolverBase
class	MeshAdaptivityOptions
	Container for mesh adaptivity options. More...
class	MeshBuilder
class	MoleFractionsDirichletBCFactory
	Parses mole fraction values and converts to mass fractions. More...
class	MooneyRivlin
class	MultcomponentVectorVariable
	Variables that are effectively vectors. More...
class	MulticomponentVariable
	Variables that may components, but are not intended to be vectors. More...
class	MultiphysicsSystem
	Interface with libMesh for solving Multiphysics problems. More...
class	NeumannBCAbstract
class	NeumannBCContainer
class	NeumannBCFactoryAbstract
class	NeumannBCFunctionBase
class	NeumannBCOldStyleFactoryAbstract
class	OldStyleBCBuilder
	Manages runtime construction of Dirichlet boundary conditions. More...
class	OutputParsing
	Functions for naming input sections/variables related to output. More...
class	ParameterAntiochReset
class	ParameterManager
	Simple class to hold and initialize a ParameterVector. More...
class	ParameterUser
	ParameterUser base class. Utility methods for subclasses. More...
class	ParsedBoundaryQoI
	Parsed Boundary QoI. More...
class	ParsedConductivity
class	ParsedDirichletBCFactory
	For notational convenience. More...
class	ParsedDirichletOldStyleBCFactory
	For notational convenience. More...
class	ParsedFEMDirichletBCFactory
	For notational convenience. More...
class	ParsedFEMDirichletOldStyleBCFactory
	For notational convenience. More...
class	ParsedFEMNeumannBC
class	ParsedFunctionDirichletBCFactory
class	ParsedFunctionDirichletOldStyleBCFactory
class	ParsedFunctionFactoryHelper
class	ParsedFunctionNeumannBCFactory
class	ParsedFunctionNeumannBCFactoryHelper
class	ParsedFunctionNeumannOldStyleBCFactory
struct	ParsedFunctionTraits
struct	ParsedFunctionTraits< libMesh::FEMFunctionBase< FEShape > >
struct	ParsedFunctionTraits< libMesh::FunctionBase< FEShape > >
class	ParsedInteriorQoI
	Parsed Interior QoI. More...
class	ParsedNeumannBC
class	ParsedPropertyBase
	Base class for material properties based on ParsedFunction. More...
class	ParsedSourceTerm
class	ParsedTractionBCFactory
class	ParsedVelocitySource
	Physics class for Velocity Penalty. More...
class	ParsedVelocitySourceAdjointStabilization
	Adds Velocity penalty adjoint stabilization source term. More...
class	ParsedVelocitySourceBase
class	ParsedViscosity
class	Physics
	Physics abstract base class. Defines API for physics to be added to MultiphysicsSystem. More...
class	PhysicsBuilder
	Manages runtime construction of Physics objects. More...
class	PhysicsFactoryBase
	Builds Physics objects, used by PhysicsBuilder. More...
class	PhysicsFactoryBasic
class	PhysicsFactoryHeatTransfer
class	PhysicsFactoryHelper
	Helper functions for PhysicsFactory. More...
class	PhysicsFactoryIncompressibleFlow
class	PhysicsFactoryIncompressibleTurbFlow
class	PhysicsFactoryInitializer
	Initialize all PhysicsFactory objects. More...
class	PhysicsFactoryOneDStressSolids
class	PhysicsFactoryPlaneStressSolids
class	PhysicsFactoryReactingFlows
class	PhysicsFactoryVariableDensityFlow
class	PhysicsFactoryWithCore
	PhysicsFactory base class for Physics that may have a related "core" Physics. More...
class	PhysicsNaming
class	PostProcessedQuantities
class	PostprocessingFactory
	This object handles constructing the postprocessing object to be used. More...
class	PowerLawCatalycity
class	PowerLawCatalycityFactory
class	PowerLawCatalycityFactoryOldStyle
class	PrescribedDispDirichletOldStyleBCFactory
class	PrescribedMoleFractionsDirichletOldStyleBCFactory
class	PrescribedSpeciesDirichletOldStyleBCFactory
class	PrescribedVectorValueDirichletOldStyleBCFactory
class	PrescribedVelDirichletOldStyleBCFactory
class	PressureFEVariable
class	PressurePinning
	Class to hold typical boundary condition methods. More...
class	PrimitiveTempFEVariables
class	QoIBase
class	QoIFactory
class	QoIOptions
class	QoIOutput
	Encapsulate QoI output flags and functionality. More...
class	RayfireMesh
	RayfireMesh. More...
class	ReactingFlowsPhysicsFactoryInitializer
class	ReactingLowMachNavierStokes
class	ReactingLowMachNavierStokesAbstract
class	ReactingLowMachNavierStokesBase
class	ReactingLowMachNavierStokesSPGSMStabilization
class	ReactingLowMachNavierStokesStabilizationBase
	Adds VMS-based stabilization to LowMachNavierStokes physics class. More...
class	ReactingLowMachNavierStokesStabilizationHelper
class	RollerXBCFactory
	Pins y- and z-component of variable, so can "roll" in the x-direction. More...
class	RollerYBCFactory
	Pins x- and z-component of variable, so can "roll" in the y-direction. More...
class	RollerZBCFactory
	Pins x- and y-component of variable, so can "roll" in the z-direction. More...
class	Runner
	Class to encapsulate initializing and running GRINS Simulation. More...
class	ScalarODE
	Physics class for arbitrary scalar-valued ODEs. More...
class	ScalarVariable
	Variables with a single SCALAR component. More...
class	ScalarVariableFactory
	Factory to build SCALAR variable. More...
class	Simulation
class	SimulationBuilder
class	SimulationInitializer
	Initialize static objects needed for simulation. More...
class	SimulationParsing
class	SingleVariable
	Variables with a single component. More...
class	SolidMechanicsAbstract
class	Solver
class	SolverContext
	Simple class to hold objects passed to Solver::solve. More...
class	SolverFactoryAbstract
class	SolverFactoryBasic
class	SolverFactoryInitializer
	Initialize all Factory objects related to Solvers. More...
class	SolverNames
class	SolverParsing
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	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	SpeciesMassFractionsVariable
class	SpeciesVariableFactory
	Factory to build FEVariablesBase classes that use species names as variables. More...
class	SpectroscopicAbsorption
	QoI class for absorption calculations using the Beer-Lambert Law. More...
class	StabilizationHelper
class	SteadyMeshAdaptiveSolver
class	SteadySolver
class	SteadyVisualization
class	Stokes
	Physics class for Stokes. More...
class	StrategiesParsing
class	StressStrainLaw
class	SymmetryTypeBCFactories
struct	thermo_type
class	ThermoPressureVariable
class	TimeSteppingParsing
class	TractionOldStyleBCFactory
class	TurbulenceFEVariables
class	TurbulenceModelsBase
	Physics class for Turbulence Models. More...
struct	TypeFrom
struct	TypeFrom< FunctionType, true >
class	UnsteadyMeshAdaptiveSolver
class	UnsteadySolver
class	UnsteadyVisualization
class	VariableBuilder
	Manages runtime construction of the FEVariableBase objects. More...
class	VariableFactoryAbstract
class	VariableFactoryBase
	Common implementations. More...
class	VariableFactoryBasic
	Factory to build "standard" FEVariablesBase classes. More...
class	VariableFactoryInitializer
	Initialize all VariableFactory objects. More...
class	VariablePinning
class	VariablesParsing
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
class	VelocityVariable
struct	viscosity_type
class	ViscosityBase
	Base class for viscosity models. More...
class	Visualization
class	VisualizationFactory
class	Vorticity
	Vorticity QoI. More...
class	WeightedFluxQoI
class	XYSymmetryBCFactory
	Pins z-component of variable (symmetry about xy-plane) More...
class	XZSymmetryBCFactory
	Pins y-component of variable (symmetry about xz-plane) More...
class	YZSymmetryBCFactory
	Pins x-component of variable (symmetry about yz-plane) More...

Typedefs
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, SharedPtr< GRINS::Physics > >	PhysicsList
	Container for GRINS::Physics object pointers. More...
typedef std::map< std::string, SharedPtr< GRINS::Physics > >::const_iterator	PhysicsListIter
	Iterator for PhysicsList. More...

Functions
template void	OldStyleBCBuilder::set_dirichlet_bc_factory_old_style_quantities< libMesh::FunctionBase< libMesh::Number > > (const std::string &, unsigned int, const std::vector< std::string > &)
template void	OldStyleBCBuilder::set_dirichlet_bc_factory_old_style_quantities< libMesh::FEMFunctionBase< libMesh::Number > > (const std::string &, unsigned int, const std::vector< std::string > &)
template void	OldStyleBCBuilder::set_neumann_bc_factory_old_style_quantities< libMesh::FunctionBase< libMesh::Number > > (const std::string &, unsigned int, const std::vector< std::string > &)
template void	OldStyleBCBuilder::set_neumann_bc_factory_old_style_quantities< libMesh::FEMFunctionBase< libMesh::Number > > (const std::string &, unsigned int, const std::vector< std::string > &)
template void	QoIFactory::get_var_value< std::string > (const GetPot &, std::string &, std::string, std::string)
template void	QoIFactory::get_var_value< libMesh::Real > (const GetPot &, libMesh::Real &, std::string, libMesh::Real)
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...
void	grins_version_stdout ()
int	get_grins_version ()

Variables
const unsigned int	invalid_var_index = std::numeric_limits<unsigned int>::max()
	Invalid varaible index id. More...
const std::string	avg_nusselt = "average_nusselt_number"
const std::string	vorticity = "vorticity"
const std::string	parsed_boundary = "parsed_boundary"
const std::string	parsed_interior = "parsed_interior"
const std::string	weighted_flux = "weighted_flux"
const std::string	integrated_function = "integrated_function"
const std::string	spectroscopic_absorption = "spectroscopic_absorption"
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"

Detailed Description

GRINS namespace.

Typedef Documentation

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 56 of file var_typedefs.h.

typedef std::map< std::string,SharedPtr<GRINS::Physics> > GRINS::PhysicsList

Container for GRINS::Physics object pointers.

Definition at line 59 of file var_typedefs.h.

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

Iterator for PhysicsList.

Definition at line 62 of file var_typedefs.h.

typedef std::string GRINS::PhysicsName

Definition at line 33 of file physics_naming.h.

typedef unsigned int GRINS::VariableIndex

More descriptive name of the type used for variable indices.

Definition at line 42 of file var_typedefs.h.

typedef std::string GRINS::VariableName

Definition at line 52 of file var_typedefs.h.

Function Documentation

int GRINS::get_grins_version

(

)

Definition at line 51 of file grins_version.C.

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().

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 void GRINS::OldStyleBCBuilder::set_dirichlet_bc_factory_old_style_quantities< libMesh::FEMFunctionBase< libMesh::Number > >	(	const std::string &	,
		unsigned	int,
		const std::vector< std::string > &
	)

template void GRINS::OldStyleBCBuilder::set_dirichlet_bc_factory_old_style_quantities< libMesh::FunctionBase< libMesh::Number > >	(	const std::string &	,
		unsigned	int,
		const std::vector< std::string > &
	)

template void GRINS::OldStyleBCBuilder::set_neumann_bc_factory_old_style_quantities< libMesh::FEMFunctionBase< libMesh::Number > >	(	const std::string &	,
		unsigned	int,
		const std::vector< std::string > &
	)

template void GRINS::OldStyleBCBuilder::set_neumann_bc_factory_old_style_quantities< libMesh::FunctionBase< libMesh::Number > >	(	const std::string &	,
		unsigned	int,
		const std::vector< std::string > &
	)

template void GRINS::QoIFactory::get_var_value< libMesh::Real >	(	const GetPot &	,
		libMesh::Real &	,
		std::string	,
		libMesh::Real
	)

template void GRINS::QoIFactory::get_var_value< std::string >	(	const GetPot &	,
		std::string &	,
		std::string	,
		std::string
	)

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);
  }

Variable Documentation

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 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 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.

const std::string GRINS::integrated_function = "integrated_function"

Definition at line 35 of file qoi_names.h.

Referenced by GRINS::QoIFactory::add_qoi().

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 50 of file var_typedefs.h.

const std::string GRINS::nu_var_name_default = "nu"

z-velocity

Definition at line 51 of file variable_name_defaults.h.

const std::string GRINS::p_var_name_default = "p"

pressure

Definition at line 60 of file variable_name_defaults.h.

const std::string GRINS::parsed_boundary = "parsed_boundary"

Definition at line 32 of file qoi_names.h.

Referenced by GRINS::QoIFactory::add_qoi().

const std::string GRINS::parsed_interior = "parsed_interior"

Definition at line 33 of file qoi_names.h.

Referenced by GRINS::QoIFactory::add_qoi().

const std::string GRINS::scalar_ode_var_name_default = "scalar_var"

arbitrary scalar ODE variable name

Definition at line 69 of file variable_name_defaults.h.

const std::string GRINS::spectroscopic_absorption = "spectroscopic_absorption"

Definition at line 36 of file qoi_names.h.

Referenced by GRINS::QoIFactory::add_qoi().

const std::string GRINS::T_var_name_default = "T"

temperature

Definition at line 63 of file variable_name_defaults.h.

const std::string GRINS::u_disp_name_default = "u"

Definition at line 89 of file variable_name_defaults.h.

const std::string GRINS::u_r_var_name_default = "r_vel"

r-velocity (axisymmetric case)

Definition at line 54 of file variable_name_defaults.h.

const std::string GRINS::u_var_name_default = "u"

Default physics variable names.

These are the default string names for all the available physics variables. These can be reset by the user, but we provide sane defaults here.

Todo:

Should we put the default physics variable names in a class instead of just GRINS namespace?

x-velocity

Definition at line 42 of file variable_name_defaults.h.

const std::string GRINS::u_z_var_name_default = "z_vel"

z-velocity (axisymmetric case)

Definition at line 57 of file variable_name_defaults.h.

const std::string GRINS::v_disp_name_default = "v"

Definition at line 90 of file variable_name_defaults.h.

const std::string GRINS::v_var_name_default = "v"

y-velocity

Definition at line 45 of file variable_name_defaults.h.

const std::string GRINS::vorticity = "vorticity"

Definition at line 31 of file qoi_names.h.

Referenced by GRINS::QoIFactory::add_qoi().

const std::string GRINS::w_disp_name_default = "w"

Definition at line 91 of file variable_name_defaults.h.

const std::string GRINS::w_var_name_default = "w"

z-velocity

Definition at line 48 of file variable_name_defaults.h.

const std::string GRINS::weighted_flux = "weighted_flux"

Definition at line 34 of file qoi_names.h.

Referenced by GRINS::QoIFactory::add_qoi().