Classes | Namespaces | Macros | Variables
messageStream.H File Reference
Include dependency graph for messageStream.H:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  messageStream
 Class to handle messaging in a simple, consistent stream-based manner. More...
 

Namespaces

 Foam
 Namespace for OpenFOAM.
 

Macros

#define FUNCTION_NAME   __func__
 
#define SeriousErrorIn(functionName)   ::Foam::SeriousError((functionName), __FILE__, __LINE__)
 Report an error message using Foam::SeriousError. More...
 
#define SeriousErrorInFunction   SeriousErrorIn(FUNCTION_NAME)
 Report an error message using Foam::SeriousError. More...
 
#define SeriousIOErrorIn(functionName, ios)   ::Foam::SeriousError((functionName), __FILE__, __LINE__, ios)
 Report an IO error message using Foam::SeriousError. More...
 
#define SeriousIOErrorInFunction(ios)   SeriousIOErrorIn(FUNCTION_NAME, ios)
 Report an IO error message using Foam::SeriousError. More...
 
#define WarningIn(functionName)   ::Foam::Warning((functionName), __FILE__, __LINE__)
 Report a warning using Foam::Warning. More...
 
#define WarningInFunction   WarningIn(FUNCTION_NAME)
 Report a warning using Foam::Warning. More...
 
#define IOWarningIn(functionName, ios)   ::Foam::Warning((functionName), __FILE__, __LINE__, (ios))
 Report an IO warning using Foam::Warning. More...
 
#define IOWarningInFunction(ios)   IOWarningIn(FUNCTION_NAME, ios)
 Report an IO warning using Foam::Warning. More...
 
#define InfoIn(functionName)   ::Foam::Info((functionName), __FILE__, __LINE__)
 Report an information message using Foam::Info. More...
 
#define InfoInFunction   InfoIn(FUNCTION_NAME)
 Report an information message using Foam::Info. More...
 
#define Log   if (log) Info
 Report write to Foam::Info if the local log switch is true. More...
 
#define IOInfoIn(functionName, ios)   ::Foam::Info((functionName), __FILE__, __LINE__, (ios))
 Report an IO information message using Foam::Info. More...
 
#define IOInfoInFunction(ios)   IOInfoIn(FUNCTION_NAME, ios)
 Report an IO information message using Foam::Info. More...
 
#define DebugInfo   if (debug) Info
 Report an information message using Foam::Info. More...
 
#define DebugInFunction   if (debug) InfoInFunction
 Report an information message using Foam::Info. More...
 
#define DebugVar(var)
 Report a variable name and value. More...
 

Variables

messageStream SeriousError
 
messageStream Warning
 
messageStream Info
 

Detailed Description

Original source file messageStream.H

Definition in file messageStream.H.

Macro Definition Documentation

#define FUNCTION_NAME   __func__

Definition at line 226 of file messageStream.H.

Referenced by IOerror::ioEndLineNumber().

#define SeriousErrorIn (   functionName)    ::Foam::SeriousError((functionName), __FILE__, __LINE__)

Report an error message using Foam::SeriousError.

for functionName in file __FILE__ at line __LINE__

Definition at line 232 of file messageStream.H.

#define SeriousErrorInFunction   SeriousErrorIn(FUNCTION_NAME)
#define SeriousIOErrorIn (   functionName,
  ios 
)    ::Foam::SeriousError((functionName), __FILE__, __LINE__, ios)

Report an IO error message using Foam::SeriousError.

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

Definition at line 243 of file messageStream.H.

#define SeriousIOErrorInFunction (   ios)    SeriousIOErrorIn(FUNCTION_NAME, ios)

Report an IO error message using Foam::SeriousError.

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

Definition at line 249 of file messageStream.H.

Referenced by IOobject::readHeader().

#define WarningIn (   functionName)    ::Foam::Warning((functionName), __FILE__, __LINE__)

Report a warning using Foam::Warning.

for functionName in file __FILE__ at line __LINE__

Definition at line 254 of file messageStream.H.

Referenced by fvMeshAdder::MapDimFields(), and refinementHistory::refinementHistory().

#define WarningInFunction   WarningIn(FUNCTION_NAME)

Report a warning using Foam::Warning.

for FUNCTION_NAME in file __FILE__ at line __LINE__

Definition at line 259 of file messageStream.H.

Referenced by polyTopoChange::addMesh(), faceZoneSet::addSet(), fileMonitor::addWatch(), polyMeshGeometry::affectedCells(), manualGAMGProcAgglomeration::agglomerate(), searchableSurfaceToFaceZone::applyToSet(), faceZoneToFaceZone::applyToSet(), setToPointZone::applyToSet(), setToCellZone::applyToSet(), setToFaceZone::applyToSet(), setAndNormalToFaceZone::applyToSet(), setsToFaceZone::applyToSet(), fieldToCell::applyToSet(), ash::ash(), Foam::average(), bufferedAccumulator< Type >::averaged(), booleanSurface::booleanSurface(), C::C(), cachedRandom::cachedRandom(), CaCO3::CaCO3(), Foam::meshTools::calcBoxPointNormals(), polyDualMesh::calcFeatures(), CentredFitSnGradData< Polynomial >::calcFit(), FitData< FitDataType, ExtendedStencil, Polynomial >::calcFit(), forces::calcForcesMoment(), wedgePolyPatch::calcGeometry(), mappedPatchBase::calcMapping(), snappySnapDriver::calcNearestSurface(), addPatchCellLayer::calcSidePatch(), ThermoParcel< ParcelType >::calcSurfaceValues(), cyclicAMIPolyPatch::calcTransforms(), cyclicPolyPatch::calcTransforms(), LiquidEvaporation< CloudType >::calculate(), LiquidEvaporationBoil< CloudType >::calculate(), COxidationMurphyShaddix< CloudType >::calculate(), ReactingParcel< ParcelType >::cellValueSourceCorrection(), ThermoParcel< ParcelType >::cellValueSourceCorrection(), cellModel::centre(), faceZone::checkAddressing(), option::checkApplied(), primitiveMeshGeometry::checkCellDeterminant(), polyMeshGeometry::checkCellDeterminant(), meshRefinement::checkData(), zone::checkDefinition(), triSurface::checkEdges(), primitiveMeshGeometry::checkFaceAngles(), polyMeshGeometry::checkFaceAngles(), primitiveMeshGeometry::checkFaceArea(), polyMeshGeometry::checkFaceArea(), primitiveMeshGeometry::checkFaceDotProduct(), polyMeshGeometry::checkFaceFlatness(), MeshedSurface< Face >::checkFaces(), primitiveMeshGeometry::checkFaceSkewness(), polyMeshGeometry::checkFaceSkewness(), primitiveMeshGeometry::checkFaceTwist(), polyMeshGeometry::checkFaceTwist(), primitiveMeshGeometry::checkFaceWeights(), polyMeshGeometry::checkFaceWeights(), regIOobject::checkIn(), TableBase< Type >::checkMaxBounds(), edgeCollapser::checkMeshQuality(), TableBase< Type >::checkMinBounds(), objectRegistry::checkOut(), AMIMethod< SourcePatch, TargetPatch >::checkPatches(), enrichedPatch::checkSupport(), triSurface::checkTriangles(), polyMeshGeometry::checkTriangleTwist(), polyMeshGeometry::checkVolRatio(), MeshedSurface< Face >::checkZones(), surfMesh::checkZones(), dlLibraryTable::close(), IOstream::compressionEnum(), ConstantRateDevolatilisation< CloudType >::ConstantRateDevolatilisation(), hexCellLooper::cut(), structuredDecomp::decompose(), faceZoneSet::deleteSet(), directionMixedFvPatchField< Type >::directionMixedFvPatchField(), directions::directions(), Foam::dlOpen(), Foam::dlSym(), snappyLayerDriver::doLayers(), snappySnapDriver::doSnap(), greyMeanAbsorptionEmission::ECont(), wideBandAbsorptionEmission::ECont(), Foam::eigenValues(), SpalartAllmaras< BasicTurbulenceModel >::epsilon(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), hexRef8::faceLevel(), polyMeshTetDecomposition::faceTetIndices(), extendedEdgeMesh::featurePointNormals(), writeFiles::file(), fileMonitorWatcher::fileMonitorWatcher(), IOobject::fileNameComponents(), probes::findElements(), patchProbes::findElements(), indexedOctree< Type >::findLine(), polyTopoChanger::findModifierID(), dynamicIndexedOctree< Type >::findNearest(), fixedGradientFvPatchField< Type >::fixedGradientFvPatchField(), fixedValueFvPatchField< Type >::fixedValueFvPatchField(), IOstream::formatEnum(), Foam::gAverage(), objectRegistry::getEvent(), DelaunayMesh< Triangulation >::getNewCellIndex(), particle< Type >::getNewParticleID(), DelaunayMesh< Triangulation >::getNewVertexIndex(), coupledPolyPatch::getRotation(), greyMeanSolidAbsorptionEmission::greyMeanSolidAbsorptionEmission(), polyBoundaryMesh::groupPatchIDs(), if(), particle< Type >::initCellFacePt(), AMIMethod< SourcePatch, TargetPatch >::initialise(), faceAreaWeightAMI< SourcePatch, TargetPatch >::interArea(), interpolation2DTable< Type >::interpolation2DTable(), IOdictionary::IOdictionary(), IOField< Type >::IOField(), IOList< T >::IOList(), IOmapDistribute::IOmapDistribute(), CompositionModel< CloudType >::L(), lduPrimitiveMesh::lduPrimitiveMesh(), janafThermo< EquationOfState >::limit(), LiquidEvaporation< CloudType >::LiquidEvaporation(), LiquidEvaporationBoil< CloudType >::LiquidEvaporationBoil(), Foam::ln(), cellModel::mag(), fvMeshAdder::MapSurfaceFields(), fvMeshAdder::MapVolFields(), meshRefinement::mergeBaffles(), meshToMesh0::meshToMesh0(), meshTriangulation::meshTriangulation(), mixedFvPatchField< Type >::mixedFvPatchField(), motionSmootherAlgo::modifyMotionPoints(), wallDist::n(), NamedEnum< Enum, nEnum >::names(), polyBoundaryMesh::neighbourEdges(), regionCoupledBase::neighbPatchID(), cyclicAMIPolyPatch::neighbPatchID(), cyclicPolyPatch::neighbPatchID(), cellCuts::nonAnchorPoints(), polyMesh::oldPoints(), dlLibraryTable::open(), listPlusEqOp< T >::operator()(), interpolation2DTable< Type >::operator()(), interpolationTable< Type >::operator()(), Time::operator++(), lduMatrix::operator+=(), lduMatrix::operator-=(), Foam::operator<<(), interpolationTable< Type >::operator[](), InflationInjection< CloudType >::parcelsToInject(), ParticleErosion< CloudType >::ParticleErosion(), patchInteractionDataList::patchInteractionDataList(), PatchPostProcessing< CloudType >::PatchPostProcessing(), polyBoundaryMesh::patchSet(), sampledSet::pointInCell(), polyBoundaryMesh::polyBoundaryMesh(), polyMesh::polyMesh(), Foam::polyMeshZipUpCells(), Polynomial< Type >::Polynomial(), turbulenceFields::processField(), processorCyclicFvPatchField< Type >::processorCyclicFvPatchField(), liquidMixtureProperties::pvInvert(), liquidProperties::pvInvert(), interpolationTable< Type >::rateOfChange(), AC3DsurfaceFormat< Face >::read(), systemCall::read(), wallShearStress::read(), functionObjectList::read(), probes::read(), wallBoundedStreamLine::read(), pressure::read(), Time::readDict(), functionObjectList::readFunctionObject(), surfMesh::readUpdate(), polyMesh::readUpdate(), Foam::readUpto(), dynamicRefineFvMesh::refine(), refinementHistory::refinementHistory(), structuredRenumber::renumber(), Foam::reusable(), thermalBaffleFvPatchScalarField::rmap(), Foam::rmDir(), timeSelector::select0(), InteractionLists< ParticleType >::sendReferredData(), cellSetOption::setCellSet(), cellSizeFunction::setCellSize(), ReactingParcel< ParcelType >::setCellValues(), ThermoParcel< ParcelType >::setCellValues(), KinematicParcel< ParcelType >::setCellValues(), Time::setControls(), removeCells::setRefinement(), refinementIterator::setRefinement(), perfectInterface::setRefinement(), removeFaces::setRefinement(), sigmaRadial::sigmaRadial(), SingleKineticRateDevolatilisation< CloudType >::SingleKineticRateDevolatilisation(), seulex::solve(), PatchTools::sortedPointEdges(), splineInterpolationWeights::splineInterpolationWeights(), meshRefinement::splitMesh(), meshRefinement::splitMeshRegions(), regionFunctionObject::store(), faceZoneSet::subset(), hexRef8::subset(), surfaceIntersection::surfaceIntersection(), surfacePatchIOList::surfacePatchIOList(), SVD::SVD(), TAB< CloudType >::TAB(), polyMesh::tetBasePtIs(), thresholdCellFaces::thresholdCellFaces(), distribution::totalEntries(), triSurfaceSearch::tree(), treeBoundBox::treeBoundBox(), polyMeshTetDecomposition::triangleTetIndices(), dynamicRefineFvMesh::unrefine(), multiSolidBodyMotionFvMesh::update(), solidBodyMotionFvMesh::update(), inclinedFilmNusseltHeightFvPatchScalarField::updateCoeffs(), inclinedFilmNusseltInletVelocityFvPatchVectorField::updateCoeffs(), edgeVertex::updateLabels(), CellZoneInjection< CloudType >::updateMesh(), fileMonitor::updateStates(), TableBase< Type >::wordToBoundsHandling(), interpolation2DTable< Type >::wordToBoundsHandling(), interpolationTable< Type >::wordToBoundsHandling(), writeObjects::write(), graph::write(), oldCyclicPolyPatch::write(), volRegion::write(), dictionary::write(), surfaceRegion::write(), interpolation2DTable< Type >::Xi(), absorptionCoeffs::~absorptionCoeffs(), and fileMonitorWatcher::~fileMonitorWatcher().

#define IOWarningIn (   functionName,
  ios 
)    ::Foam::Warning((functionName), __FILE__, __LINE__, (ios))

Report an IO warning using Foam::Warning.

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

Definition at line 265 of file messageStream.H.

#define IOWarningInFunction (   ios)    IOWarningIn(FUNCTION_NAME, ios)
#define InfoIn (   functionName)    ::Foam::Info((functionName), __FILE__, __LINE__)

Report an information message using Foam::Info.

for functionName in file __FILE__ at line __LINE__

Definition at line 276 of file messageStream.H.

#define InfoInFunction   InfoIn(FUNCTION_NAME)

Report an information message using Foam::Info.

for FUNCTION_NAME in file __FILE__ at line __LINE__

Definition at line 281 of file messageStream.H.

Referenced by tabulated6DoFAcceleration::acceleration(), kinematicSingleLayer::addSources(), Cloud< ParticleType >::autoMap(), GeometricField< Type, PatchField, GeoMesh >::Boundary::Boundary(), nearWallFields::calcAddressing(), faceZone::calcCellLayers(), faceZone::calcFaceZonePatch(), zone::calcLookupMap(), viewFactor::calculate(), MeshedSurfaceProxy< Face >::canWriteType(), CentredFitData< Polynomial >::CentredFitData(), CentredFitSnGradData< Polynomial >::CentredFitSnGradData(), primitiveMesh::checkCellsZipUp(), primitiveMesh::checkCellVolumes(), primitiveMesh::checkClosedBoundary(), primitiveMesh::checkClosedCells(), primitiveMesh::checkConcaveCells(), primitiveMesh::checkFaceAngles(), primitiveMesh::checkFaceAreas(), primitiveMesh::checkFaceFaces(), primitiveMesh::checkFaceFlatness(), primitiveMesh::checkFaceOrthogonality(), primitiveMesh::checkFacePyramids(), primitiveMesh::checkFaceSkewness(), primitiveMesh::checkFaceVertices(), primitiveMesh::checkMesh(), primitiveMesh::checkPoints(), PrimitivePatch< Face, FaceList, PointField, PointType >::checkTopology(), primitiveMesh::checkUpperTriangular(), polyMesh::clearAdditionalGeom(), surfMesh::clearAddressing(), polyMesh::clearAddressing(), polyMesh::clearCellTree(), PrimitivePatch< Face, FaceList, PointField, PointType >::clearGeom(), surfMesh::clearGeom(), polyMesh::clearGeom(), PrimitivePatch< Face, FaceList, PointField, PointType >::clearPatchMeshAddr(), PrimitivePatch< Face, FaceList, PointField, PointType >::clearTopology(), dlLibraryTable::close(), regIOobject::close(), kinematicSingleLayer::continuityCheck(), coordinateSystem::coordinateSystem(), hePsiThermo< BasicPsiThermo, MixtureType >::correct(), heRhoThermo< BasicPsiThermo, MixtureType >::correct(), heheuPsiThermo< BasicPsiThermo, MixtureType >::correct(), heSolidThermo< BasicSolidThermo, MixtureType >::correct(), limitedSnGrad< Type >::correction(), Foam::cp(), fvMesh::delta(), distributedTriSurfaceMesh::distribute(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), StaticHashTable< T, Key, Hash >::erase(), GeometricField< Type, PatchField, GeoMesh >::Boundary::evaluate(), thermoSingleLayer::evolveRegion(), kinematicSingleLayer::evolveRegion(), StaticHashTable< T, Key, Hash >::find(), HashTable< T, Key, Hash >::find(), patchProbes::findElements(), Time::findInstance(), mappedPatchBase::findSamples(), Time::findTimes(), ZoneMesh< ZoneType, MeshType >::findZoneID(), StaticHashTable< T, Key, Hash >::found(), HashTable< T, Key, Hash >::found(), ddtScheme< Type >::fvcDdtPhiCoeff(), fvMatrix< Type >::fvMatrix(), fvMesh::fvMesh(), GeometricField< Type, PatchField, GeoMesh >::GeometricField(), sampledSet::getTrackingPoint(), IOobject::headerOk(), IFstream::IFstream(), interpolationCellPointFace< Type >::interpolate(), surfaceInterpolationScheme< Type >::interpolate(), IOobject::IOobject(), Foam::ln(), IOobjectList::lookup(), IOobjectList::lookupClass(), fvMesh::mapFields(), polyMesh::movePoints(), Foam::mv(), Foam::mvBak(), options::New(), thermophysicalFunction::New(), interpolationWeights::New(), gradScheme< Type >::New(), snGradScheme< Type >::New(), surfaceInterpolationScheme< Type >::New(), ddtScheme< Type >::New(), d2dt2Scheme< Type >::New(), curvedEdge::New(), divScheme< Type >::New(), fvPatch::New(), convectionScheme< Type >::New(), GAMGProcAgglomeration::New(), multivariateSurfaceInterpolationScheme< Type >::New(), polyMeshModifier::New(), facePointPatch::New(), limitedSurfaceInterpolationScheme< Type >::New(), solidProperties::New(), laplacianScheme< Type, GType >::New(), liquidProperties::New(), pointZone::New(), cellZone::New(), pointPatchField< Type >::New(), UnsortedMeshedSurface< Face >::New(), fvsPatchField< Type >::New(), faceZone::New(), fvPatchField< Type >::New(), MeshedSurface< Face >::New(), polyPatch::New(), OFstream::OFstream(), dlLibraryTable::open(), thermoSingleLayer::preEvolveRegion(), kinematicSingleLayer::preEvolveRegion(), dictionary::read(), Foam::readDir(), GeometricField< Type, PatchField, GeoMesh >::Boundary::readField(), IOobject::readHeader(), regIOobject::readIfModified(), regIOobject::readStream(), fvMesh::readUpdate(), surfMesh::readUpdate(), polyMesh::readUpdate(), fvMatrix< Type >::relax(), GeometricField< Type, PatchField, GeoMesh >::relax(), polyMesh::removeBoundary(), fvMesh::removeFvBoundary(), surfMesh::removeZones(), thermoSingleLayer::resetPrimaryRegionSourceTerms(), kinematicSingleLayer::resetPrimaryRegionSourceTerms(), StaticHashTable< T, Key, Hash >::resize(), HashTable< T, Key, Hash >::resize(), Foam::rm(), Foam::rmDir(), searchablePlate::searchablePlate(), IOobject::setBad(), surfMesh::setInstance(), polyMesh::setInstance(), reactingOneDim::solveContinuity(), kinematicSingleLayer::solveContinuity(), thermalBaffle::solveEnergy(), reactingOneDim::solveEnergy(), thermoSingleLayer::solveEnergy(), kinematicSingleLayer::solveMomentum(), reactingOneDim::solveSpeciesMass(), kinematicSingleLayer::solveThickness(), HashTable< T, Key, Hash >::sortedToc(), MeshedSurface< Face >::stitchFaces(), GeometricField< Type, PatchField, GeoMesh >::storeOldTime(), GeometricField< Type, PatchField, GeoMesh >::storePrevIter(), PrimitivePatch< Face, FaceList, PointField, PointType >::surfaceType(), timer::timer(), StaticHashTable< T, Key, Hash >::toc(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), thermoSingleLayer::transferPrimaryRegionThermoFields(), kinematicSingleLayer::transferPrimaryRegionThermoFields(), mixerFvMesh::update(), GeometricField< Type, PatchField, GeoMesh >::Boundary::updateCoeffs(), polyMesh::updateMesh(), thermoSingleLayer::updateSubmodels(), kinematicSingleLayer::updateSubmodels(), UpwindFitData< Polynomial >::UpwindFitData(), fvMesh::V(), fvMesh::V00(), wallLayerCells::wallLayerCells(), ParticleTracks< CloudType >::write(), MeshedSurfaceProxy< Face >::write(), edgeMesh::write(), UnsortedMeshedSurface< Face >::write(), MeshedSurface< Face >::write(), IOobject::writeHeader(), regIOobject::writeObject(), dlLibraryTable::~dlLibraryTable(), fvMatrix< Type >::~fvMatrix(), leastSquaresVectors::~leastSquaresVectors(), LeastSquaresVectors< Stencil >::~LeastSquaresVectors(), skewCorrectionVectors::~skewCorrectionVectors(), and timer::~timer().

#define Log   if (log) Info
#define IOInfoIn (   functionName,
  ios 
)    ::Foam::Info((functionName), __FILE__, __LINE__, (ios))

Report an IO information message using Foam::Info.

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

Definition at line 291 of file messageStream.H.

#define IOInfoInFunction (   ios)    IOInfoIn(FUNCTION_NAME, ios)

Report an IO information message using Foam::Info.

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

Definition at line 297 of file messageStream.H.

Referenced by dictionary::lookupOrAddDefault(), dictionary::lookupOrDefault(), and dictionary::readIfPresent().

#define DebugInfo   if (debug) Info
#define DebugInFunction   if (debug) InfoInFunction
#define DebugVar (   var)
Value:
{ \
::Foam::string oldPrefix(::Foam::Pout.prefix()); \
::Foam::Pout<< "["<< __FILE__ << ":" << __LINE__ << "] "; \
::Foam::Pout.prefix() = oldPrefix + #var " "; \
::Foam::Pout.prefix() = oldPrefix; \
}
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:253
prefixOSstream Pout(cout,"Pout")
Definition: IOstreams.H:53
const string & prefix() const
Return the prefix of the stream.
A class for handling character strings derived from std::string.
Definition: string.H:74

Report a variable name and value.

using Foam::Pout in file __FILE__ at line __LINE__

Definition at line 313 of file messageStream.H.