Include dependency graph for error.H:

Classes
class	Enum< EnumType >
	Enum is a wrapper around a list of names/values that represent particular enumeration (or int) values. All dictionary searches use a literal (not regex). More...

class	error
	Class to handle errors and exceptions in a simple, consistent stream-based manner. More...

class	IOerror
	Report an I/O error. More...

Namespaces
	Foam
	Namespace for OpenFOAM.

Macros
#define	FatalErrorIn(functionName) ::Foam::FatalError((functionName), __FILE__, __LINE__)
	Report an error message using Foam::FatalError. More...

#define	FatalErrorInFunction FatalErrorIn(FUNCTION_NAME)
	Report an error message using Foam::FatalError. More...

#define	FatalErrorInLookup(lookupTag, lookupName, lookupTable)
	Report an error message using Foam::FatalError. More...

#define	FatalIOErrorIn(functionName, ios) ::Foam::FatalIOError((functionName), __FILE__, __LINE__, (ios))
	Report an error message using Foam::FatalIOError. More...

#define	FatalIOErrorInFunction(ios) FatalIOErrorIn(FUNCTION_NAME, ios)
	Report an error message using Foam::FatalIOError. More...

#define	FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
	Report an error message using Foam::FatalIOError. More...

#define	SafeFatalIOErrorIn(functionName, ios, msg)
	Report an error message using Foam::FatalIOError. More...

#define	SafeFatalIOErrorInFunction(ios, msg) SafeFatalIOErrorIn(FUNCTION_NAME, ios, msg)
	Report an error message using Foam::FatalIOError. More...

#define	notImplemented(functionName)
	Issue a FatalErrorIn for a function not currently implemented. More...

#define	NotImplemented notImplemented(FUNCTION_NAME)
	Issue a FatalErrorIn for a function not currently implemented. More...

Functions
Ostream &	operator<< (Ostream &os, const error &err)
	Ostream operator. More...

Ostream &	operator<< (Ostream &os, const IOerror &err)
	Ostream operator. More...

Variables
error	FatalError
	Error stream (stdout output on all processes), with additional 'FOAM FATAL ERROR' header text and stack trace. More...

IOerror	FatalIOError
	Error stream (stdout output on all processes), with additional 'FOAM FATAL IO ERROR' header text and stack trace. More...

Detailed Description

Original source file error.H

Definition in file error.H.

Macro Definition Documentation

◆ FatalErrorIn

#define FatalErrorIn ( functionName ) ::Foam::FatalError((functionName), __FILE__, __LINE__)

Report an error message using Foam::FatalError.

for functionName in file __FILE__ at line __LINE__

Definition at line 590 of file error.H.

Referenced by faMeshDecomposition::decomposeMesh(), if(), and argList::parse().

◆ FatalErrorInFunction

#define FatalErrorInFunction FatalErrorIn(FUNCTION_NAME)

Report an error message using Foam::FatalError.

for FUNCTION_NAME in file __FILE__ at line __LINE__

Definition at line 598 of file error.H.

◆ FatalErrorInLookup

#define FatalErrorInLookup	(	lookupTag,
		lookupName,
		lookupTable
	)

Value:

::Foam::FatalError(FUNCTION_NAME, __FILE__, __LINE__)                      \
    << "Unknown " << (lookupTag) << " type " << (lookupName)                   \
    << "\n\nValid " << (lookupTag) << " types :\n"                             \
    << ((lookupTable).sortedToc()) << '\n'

Report an error message using Foam::FatalError.

about unknown lookup type in table

Definition at line 605 of file error.H.

Referenced by combustionModel::New(), simplifiedFvMesh::New(), fileOperationInitialise::New(), thermophysicalFunction::New(), interpolation< Foam::vector >::New(), thermophysicalProperties::New(), multiDimPolyFunctions::New(), interpolationWeights::New(), chemistryTabulationMethod< ReactionThermo, ThermoType >::New(), surfaceReader::New(), topoSetCellSource::New(), topoSetFaceSource::New(), topoSetPointSource::New(), topoSetCellZoneSource::New(), topoSetPointZoneSource::New(), topoSetFaceZoneSource::New(), expressionEntry::New(), GAMGInterfaceField::New(), chemistryReductionMethod< ReactionThermo, ThermoType >::New(), boundaryAdjointContribution::New(), SIMPLEControl::New(), adjointTurbulenceModel::New(), GAMGInterface::New(), facePointPatch::New(), solidProperties::New(), liquidProperties::New(), cellLooper::New(), morphingBoxConstraint::New(), designVariables::New(), fvPatch::New(), meshToMeshMethod::New(), graph::writer::New(), token::compound::New(), shapeDesignVariables::New(), topoSet::New(), polyPatch::New(), AMIInterpolation::New(), topoSetSource::New(), fileOperation::New(), coordSetWriter::New(), functionObject::New(), pointPatchField< vector >::New(), fvsPatchField< Type >::New(), faePatchField< Type >::New(), faPatchField< Type >::New(), fvExprDriver::New(), fvPatchField< vector >::New(), and edgeMesh::write().

◆ FatalIOErrorIn

#define FatalIOErrorIn	(	functionName,
		ios
	)	::Foam::FatalIOError((functionName), __FILE__, __LINE__, (ios))

Report an error message using Foam::FatalIOError.

for functionName in file __FILE__ at line __LINE__ for a particular IOstream

Definition at line 618 of file error.H.

Referenced by if().

◆ FatalIOErrorInFunction

#define FatalIOErrorInFunction ( ios ) FatalIOErrorIn(FUNCTION_NAME, ios)

Report an error message using Foam::FatalIOError.

for FUNCTION_NAME in file __FILE__ at line __LINE__ for a particular IOstream

Definition at line 627 of file error.H.

◆ FatalIOErrorInLookup

#define FatalIOErrorInLookup	(	ios,
		lookupTag,
		lookupName,
		lookupTable
	)

Value:

::Foam::FatalIOError(FUNCTION_NAME, __FILE__, __LINE__, (ios))             \
    << "Unknown " << (lookupTag) << " type " << (lookupName)                   \
    << "\n\nValid " << (lookupTag) << " types :\n"                             \
    << ((lookupTable).sortedToc()) << '\n'

Report an error message using Foam::FatalIOError.

about unknown lookup type in table

Definition at line 635 of file error.H.

Referenced by sizeDistribution::initialise(), motionDiffusivity::New(), blendingMethod::New(), conductivityModel::New(), granularPressureModel::New(), radialModel::New(), partitioningModel::New(), blockVertex::New(), viscosityModel::New(), scatterModel::New(), frictionalStressModel::New(), wallTransmissivityModel::New(), nucleationSiteModel::New(), nucleateFluxModel::New(), wallAbsorptionEmissionModel::New(), MHFModel::New(), LeidenfrostModel::New(), filmBoilingModel::New(), TDNBModel::New(), thermophysicalFunction::New(), CHFModel::New(), CHFSubCoolModel::New(), departureDiameterModel::New(), departureFrequencyModel::New(), renumberMethod::New(), tableReader< scalar >::New(), chemistryReader< gasHThermoPhysics >::New(), diameterModel::New(), saturationModel::New(), tetherPotential::New(), dragModel::New(), motionInterpolation::New(), CorrectionLimitingMethod::New(), aspectRatioModel::New(), swarmCorrection::New(), windowModel::New(), absorptionEmissionModel::New(), porousModel::New(), engineTime::New(), heatTransferModel::New(), energyScalingFunction::New(), surfaceFilmModel::New(), lnGradScheme< Type >::New(), daughterSizeDistributionModel::New(), sootModel::New(), displacementMotionSolver::New(), phaseModel::New(), surfaceTensionModel::New(), DispersionModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::New(), thermophysicalProperties::New(), generalizedNewtonianViscosityModel::New(), gradScheme< Type >::New(), primalSolver::New(), topoSetCellSource::New(), topoSetFaceSource::New(), topoSetPointSource::New(), objectiveGeometric::New(), engineMesh::New(), massTransferModel::New(), liftModel::New(), phaseTransferModel::New(), force::New(), LESdelta::New(), blockFace::New(), topoSetCellZoneSource::New(), topoSetPointZoneSource::New(), filmThermoModel::New(), filmRadiationModel::New(), WallModel< Foam::DSMCCloud >::New(), wallDampingModel::New(), topoSetFaceZoneSource::New(), zeroATCcells::New(), topOInterpolationFunction::New(), stepUpdate::New(), resolutionIndexModel::New(), AtomizationModel< Foam::SprayCloud< Foam::DSMCCloud > >::New(), virtualMassModel::New(), BinaryCollisionModel< Foam::DSMCCloud< ParcelType > >::New(), ParticleStressModel::New(), barotropicCompressibilityModel::New(), edgeInterpolationScheme< scalar >::New(), turbulentDispersionModel::New(), InflowBoundaryModel< Foam::DSMCCloud< ParcelType > >::New(), basicSolidChemistryModel::New(), WallInteractionModel< Foam::DSMCCloud< ParcelType > >::New(), convectionScheme< Type >::New(), regularisationRadius::New(), pairPotential::New(), patchDistMethod::New(), sixDoFRigidBodyMotionRestraint::New(), filmViscosityModel::New(), TimeScaleModel::New(), heatTransferCoeffModel::New(), wallLubricationModel::New(), coalescenceModel::New(), driftModel::New(), nucleationModel::New(), laminarFlameSpeed::New(), solidBodyMotionFunction::New(), coordinateRotation::New(), CollisionModel< Foam::CollidingCloud< Foam::DSMCCloud > >::New(), fvGeometryScheme::New(), binaryBreakupModel::New(), incompressiblePrimalSolver::New(), DevolatilisationModel< Foam::ReactingMultiphaseCloud< Foam::DSMCCloud > >::New(), integrationScheme::New(), DMDModel::New(), divScheme< Type >::New(), IATEsource::New(), histogramModel::New(), StochasticCollisionModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::New(), surfaceInterpolationScheme< GType >::New(), IsotropyModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::New(), faD2dt2Scheme< Type >::New(), SurfaceReactionModel< Foam::ReactingMultiphaseCloud< Foam::DSMCCloud > >::New(), faDdtScheme< scalar >::New(), d2dt2Scheme< Type >::New(), phaseChangeModel::New(), displacementMethod::New(), LESfilter::New(), twoPhaseSystem::New(), snGradScheme< Type >::New(), controlPointsDefinition::New(), DampingModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::New(), BreakupModel< Foam::SprayCloud< Foam::DSMCCloud > >::New(), betaMax::New(), sixDoFRigidBodyMotionConstraint::New(), extrudeModel::New(), breakupModel::New(), convectionScheme< scalar >::New(), CompositionModel< Foam::ReactingCloud< Foam::DSMCCloud > >::New(), regionModelFunctionObject::New(), PackingModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::New(), injectionModel::New(), transferModel::New(), PairModel< Foam::DSMCCloud >::New(), reactionRateFlameArea::New(), HeterogeneousReactingModel< Foam::ReactingHeterogeneousCloud< CloudType > >::New(), decompositionConstraint::New(), heatExchangerModel::New(), ParticleForce< CloudType >::New(), multiphaseSystem::New(), laminarModel< BasicMomentumTransportModel >::New(), polyMeshModifier::New(), rigidBody::New(), multivariateSurfaceInterpolationScheme< scalar >::New(), AveragingMethod< Foam::vector >::New(), incompressibleAdjointSolver::New(), ATCModel::New(), distributionModel::New(), SRFModel::New(), interfaceCompositionModel::New(), externalDisplacementMeshMover::New(), restraint::New(), limitedSurfaceInterpolationScheme< Type >::New(), CloudFunctionObject< CloudType >::New(), laplacianScheme< Type >::New(), runTimeCondition::New(), searchableSurface::New(), ddtScheme< Type >::New(), rigidBodySolver::New(), regularisationPDE::New(), RASModelVariables::New(), solidProperties::New(), laplacianScheme< Type, GType >::New(), PhaseChangeModel< Foam::ReactingCloud< Foam::DSMCCloud > >::New(), trimModel::New(), blockEdge::New(), liquidProperties::New(), profileModel::New(), PatchInteractionModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::New(), objectiveIncompressible::New(), ODESolver::New(), filmTurbulenceModel::New(), thermalBaffleModel::New(), binModel::New(), thermalShellModel::New(), adjointSolver::New(), cellCellStencil::New(), pyrolysisModel::New(), dynamicFvMesh::New(), optimisationManager::New(), vibrationShellModel::New(), lineSearch::New(), adjointSensitivity::New(), reconstructionSchemes::New(), fieldValue::New(), sixDoFSolver::New(), decompositionMethod::New(), token::compound::New(), cellZone::New(), pointZone::New(), joint::New(), adjointRASModel::New(), porosityModel::New(), liquidFilmBase::New(), updateMethod::New(), radiationModel::New(), LduMatrix< Type, DType, LUType >::solver::New(), HeatTransferModel< Foam::ThermoCloud< CloudType > >::New(), lduMatrix::solver::New(), waveModel::New(), SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::New(), Reaction< ReactionThermo >::New(), faPatch::New(), InjectionModel< CloudType >::New(), option::New(), objective::New(), NURBS3DVolume::New(), sampledSurface::New(), faceZone::New(), sampledSet::New(), polyPatch::New(), topoSetSource::New(), LduMatrix< Type, DType, LUType >::smoother::New(), exprResult::New(), lduMatrix::smoother::New(), LduMatrix< Type, DType, LUType >::preconditioner::New(), fvExprDriver::New(), noiseModel::New(), lduMatrix::preconditioner::New(), and sizeDistribution::setCellZoneCells().

◆ SafeFatalIOErrorIn

#define SafeFatalIOErrorIn	(	functionName,
		ios,
		msg
	)

Value:

::Foam::IOerror::SafeFatalIOError \

((functionName), __FILE__, __LINE__, (ios), (msg))

Foam::IOerror::SafeFatalIOError

static void SafeFatalIOError(const char *functionName, const char *sourceFileName, const int sourceFileLineNumber, const IOstream &ioStream, const string &msg)

Print basic message and exit.

Definition: IOerror.C:162

Report an error message using Foam::FatalIOError.

(or cerr if FatalIOError not yet constructed) for functionName in file __FILE__ at line __LINE__ for a particular IOstream

Definition at line 649 of file error.H.

◆ SafeFatalIOErrorInFunction

#define SafeFatalIOErrorInFunction	(	ios,
		msg
	)	SafeFatalIOErrorIn(FUNCTION_NAME, ios, msg)

Report an error message using Foam::FatalIOError.

(or cerr if FatalIOError not yet constructed) for functionName in file __FILE__ at line __LINE__ for a particular IOstream

Definition at line 660 of file error.H.

Referenced by controlDict().

◆ notImplemented

#define notImplemented ( functionName )

Value:

FatalErrorIn(functionName) \

<< "Not implemented" << ::Foam::abort(FatalError);

Foam::FatalError

error FatalError

Error stream (stdout output on all processes), with additional 'FOAM FATAL ERROR' header text and sta...

Foam::abort

errorManip< error > abort(error &err)

Definition: errorManip.H:139

FatalErrorIn

#define FatalErrorIn(functionName)

Report an error message using Foam::FatalError.

Definition: error.H:590

Issue a FatalErrorIn for a function not currently implemented.

The functionName is printed and then abort is called.

This macro can be particularly useful when methods must be defined to complete the interface of a derived class even if they should never be called for this derived class.

Definition at line 673 of file error.H.

Referenced by clampedPlateFaPatchField< Type >::evaluate(), if(), and sampledInterface::sampleOnPoints().

◆ NotImplemented

#define NotImplemented notImplemented(FUNCTION_NAME)

Issue a FatalErrorIn for a function not currently implemented.

The FUNCTION_NAME is printed and then abort is called.

This macro can be particularly useful when methods must be defined to complete the interface of a derived class even if they should never be called for this derived class.

Definition at line 686 of file error.H.

Classes

Namespaces

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ FatalErrorIn

◆ FatalErrorInFunction

◆ FatalErrorInLookup

◆ FatalIOErrorIn

◆ FatalIOErrorInFunction

◆ FatalIOErrorInLookup

◆ SafeFatalIOErrorIn

◆ SafeFatalIOErrorInFunction

◆ notImplemented

◆ NotImplemented