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 InfoHeader   if (::Foam::writeInfoHeader) Info
 Report write to Foam::Info if the local log switch is true. 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
 
bool writeInfoHeader = true
 

Detailed Description

Original source file messageStream.H

Definition in file messageStream.H.

Macro Definition Documentation

◆ FUNCTION_NAME

◆ SeriousErrorIn

#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 233 of file messageStream.H.

◆ SeriousErrorInFunction

◆ SeriousIOErrorIn

#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 244 of file messageStream.H.

◆ SeriousIOErrorInFunction

#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 250 of file messageStream.H.

Referenced by IOobject::readHeader().

◆ WarningIn

#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 255 of file messageStream.H.

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

◆ WarningInFunction

#define WarningInFunction   WarningIn(FUNCTION_NAME)

Report a warning using Foam::Warning.

for FUNCTION_NAME in file __FILE__ at line __LINE__

Definition at line 260 of file messageStream.H.

Referenced by polyTopoChange::addMesh(), faceZoneSet::addSet(), massSource::addsSupToField(), fileMonitor::addWatch(), manualGAMGProcAgglomeration::agglomerate(), searchableSurfaceToFaceZone::applyToSet(), setToCellZone::applyToSet(), faceZoneToFaceZone::applyToSet(), setToPointZone::applyToSet(), setToFaceZone::applyToSet(), setAndNormalToFaceZone::applyToSet(), setsToFaceZone::applyToSet(), fieldToCell::applyToSet(), planeToFaceZone::applyToSet(), ash::ash(), Foam::average(), bufferedAccumulator< scalar >::averaged(), booleanSurface::booleanSurface(), C::C(), CaCO3::CaCO3(), Foam::meshTools::calcBoxPointNormals(), CentredFitSnGradData< Polynomial >::calcFit(), FitData< CentredFitSnGradData< Polynomial >, extendedCentredCellToFaceStencil, Polynomial >::calcFit(), forces::calcForcesMoment(), wedgePolyPatch::calcGeometry(), mappedPatchBase::calcMapping(), snappySnapDriver::calcNearestSurface(), addPatchCellLayer::calcSidePatch(), ThermoParcel< ParcelType >::calcSurfaceValues(), LiquidEvaporation< CloudType >::calculate(), LiquidEvaporationBoil< CloudType >::calculate(), COxidationMurphyShaddix< CloudType >::calculate(), ReactingParcel< ParcelType >::cellValueSourceCorrection(), ThermoParcel< ParcelType >::cellValueSourceCorrection(), cellModel::centre(), faceZone::checkAddressing(), Foam::polyMeshCheck::checkCellDeterminant(), meshRefinement::checkData(), zone::checkDefinition(), triSurface::checkEdges(), Foam::polyMeshCheck::checkFaceAngles(), Foam::polyMeshCheck::checkFaceArea(), Foam::polyMeshCheck::checkFaceFlatness(), MeshedSurface< Foam::face >::checkFaces(), Foam::polyMeshCheck::checkFaceSkewness(), Foam::polyMeshCheck::checkFaceTwist(), Foam::polyMeshCheck::checkFaceWeights(), regIOobject::checkIn(), edgeCollapser::checkMeshQuality(), Foam::polyMeshCheck::checkNonOrtho(), objectRegistry::checkOut(), AMIMethod::checkPatches(), enrichedPatch::checkSupport(), triSurface::checkTriangles(), Foam::polyMeshCheck::checkTriangleTwist(), Foam::polyMeshCheck::checkVolRatio(), MeshedSurface< Foam::face >::checkZones(), surfMesh::checkZones(), dlLibraryTable::close(), collatedFileOperation::collatedFileOperation(), IOstream::compressionEnum(), ConstantRateDevolatilisation< CloudType >::ConstantRateDevolatilisation(), waxSolventEvaporation::correctModel(), hexCellLooper::cut(), cuttingPlane::cuttingPlane(), structuredDecomp::decompose(), decomposedBlockData::decomposedBlockData(), Cloud< passiveParticle >::deleteLostParticles(), faceZoneSet::deleteSet(), directions::directions(), distanceSurface::distanceSurface(), Foam::dlOpen(), Foam::dlSym(), snappyLayerDriver::doLayers(), snappySnapDriver::doSnap(), Foam::eigenValues(), SpalartAllmaras< BasicMomentumTransportModel >::epsilon(), hexRef8::faceLevel(), tetIndices::faceTriIs(), extendedEdgeMesh::featurePointNormals(), logFiles::file(), fileMonitorWatcher::fileMonitorWatcher(), IOobject::fileNameComponents(), fileOperation::filePath(), probes::findElements(), patchProbes::findElements(), indexedOctree< Foam::treeDataFace >::findLine(), polyTopoChanger::findModifierID(), dynamicIndexedOctree< Foam::dynamicTreeDataPoint >::findNearest(), IOstream::formatEnum(), Foam::gAverage(), objectRegistry::getEvent(), DelaunayMesh< CellSizeDelaunay >::getNewCellIndex(), particle< Type >::getNewParticleID(), DelaunayMesh< CellSizeDelaunay >::getNewVertexIndex(), polyBoundaryMesh::groupPatchIDs(), particle< Type >::hitCyclicAMIPatch(), if(), AMIMethod::initialise(), faceAreaWeightAMI::interArea(), IOmapDistribute::IOmapDistribute(), CompositionModel< Foam::ThermoCloud< CloudType > >::L(), lduPrimitiveMesh::lduPrimitiveMesh(), janafThermo< EquationOfState >::limit(), LiquidEvaporation< CloudType >::LiquidEvaporation(), LiquidEvaporationBoil< CloudType >::LiquidEvaporationBoil(), Foam::ln(), cellModel::mag(), fvMeshAdder::MapPointFields(), fvMeshAdder::MapSurfaceFields(), fvMeshAdder::MapVolFields(), masterUncollatedFileOperation::masterUncollatedFileOperation(), meshRefinement::mergeBaffles(), meshToMesh0::meshToMesh0(), motionSmootherAlgo::modifyMotionPoints(), wallDist::n(), NamedEnum< compressibleField, 8 >::names(), polyBoundaryMesh::nbrEdges(), regionCoupledBase::nbrPatchID(), cyclicAMIPolyPatch::nbrPatchID(), cyclicPolyPatch::nbrPatchID(), sootModel::New(), combustionModel::New(), cellCuts::nonAnchorPoints(), fileOperation::nProcs(), dlLibraryTable::open(), listPlusEqOp< T >::operator()(), Time::operator++(), lduMatrix::operator+=(), lduMatrix::operator-=(), Foam::operator<<(), InflationInjection< CloudType >::parcelsToInject(), ParticleErosion< CloudType >::ParticleErosion(), patchInteractionDataList::patchInteractionDataList(), PatchPostProcessing< CloudType >::PatchPostProcessing(), polyBoundaryMesh::patchSet(), polyBoundaryMesh::polyBoundaryMesh(), polyMesh::polyMesh(), Foam::polyMeshZipUpCells(), Polynomial< Type >::Polynomial(), turbulenceFields::processField(), processorCyclicFvPatchField< Type >::processorCyclicFvPatchField(), fileOperation::processorsPath(), liquidMixtureProperties::pvInvert(), liquidProperties::pvInvert(), AC3DsurfaceFormat< Face >::read(), Fickian< unityLewisFourier< laminarThermophysicalTransportModel > >::read(), wallHeatFlux::read(), systemCall::read(), wallShearStress::read(), MaxwellStefan< unityLewisFourier< laminarThermophysicalTransportModel > >::read(), wallHeatTransferCoeff::read(), probes::read(), functionObjectList::read(), pressure::read(), damping::readCoeffs(), Time::readDict(), functionObjectList::readFunctionObject(), surfMesh::readUpdate(), polyMesh::readUpdate(), Foam::readUpto(), refinementHistory::refinementHistory(), kOmegaSSTLM< BasicMomentumTransportModel >::ReThetat0(), Foam::reusable(), thermalBaffleFvPatchScalarField::rmap(), Foam::rmDir(), timeSelector::select0(), InteractionLists< typename CloudType::parcelType >::sendReferredData(), cellSizeFunction::setCellSize(), ReactingParcel< ParcelType >::setCellValues(), ThermoParcel< ParcelType >::setCellValues(), MomentumParcel< ParcelType >::setCellValues(), Time::setControls(), removeCells::setRefinement(), refinementIterator::setRefinement(), perfectInterface::setRefinement(), meshCutter::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(), faceZoneSet::sync(), TAB< CloudType >::TAB(), polyMesh::tetBasePtIs(), thresholdCellFaces::thresholdCellFaces(), distribution::totalEntries(), particle< Type >::trackToFace(), triSurfaceSearch::tree(), treeBoundBox::treeBoundBox(), IOobject::typeHeaderOk(), inclinedFilmNusseltHeightFvPatchScalarField::updateCoeffs(), inclinedFilmNusseltInletVelocityFvPatchVectorField::updateCoeffs(), edgeVertex::updateLabels(), CellZoneInjection< CloudType >::updateMesh(), fileMonitor::updateStates(), IOobject::warnNoRereading(), graph::write(), surfaceFieldValue::write(), dictionary::write(), CompactIOList< face, label >::writeObject(), absorptionCoeffs::~absorptionCoeffs(), dlLibraryTable::~dlLibraryTable(), and fileMonitorWatcher::~fileMonitorWatcher().

◆ IOWarningIn

#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 266 of file messageStream.H.

◆ IOWarningInFunction

◆ InfoIn

#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 277 of file messageStream.H.

◆ InfoInFunction

#define InfoInFunction   InfoIn(FUNCTION_NAME)

Report an information message using Foam::Info.

for FUNCTION_NAME in file __FILE__ at line __LINE__

Definition at line 282 of file messageStream.H.

Referenced by 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<::Foam::List< labelledTri >, pointField >::checkTopology(), primitiveMesh::checkUpperTriangular(), surfMesh::clearAddressing(), polyMesh::clearAddressing(), polyMesh::clearCellTree(), surfMesh::clearGeom(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::clearGeom(), polyMesh::clearGeom(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::clearPatchMeshAddr(), polyMesh::clearTetBasePtIs(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::clearTopology(), dlLibraryTable::close(), vtkPVFoam::convertVolInternalField(), hePsiThermo< BasicPsiThermo, MixtureType >::correct(), heRhoThermo< BasicRhoThermo, MixtureType >::correct(), heheuPsiThermo< BasicPsiThermo, MixtureType >::correct(), heSolidThermo< BasicSolidThermo, MixtureType >::correct(), limitedSnGrad< Type >::correction(), Foam::cp(), fvMesh::delta(), distributedTriSurfaceMesh::distribute(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), ListHashTable< T, Key, Hash >::erase(), GeometricField< Type, PatchField, GeoMesh >::Boundary::evaluate(), ListHashTable< T, Key, Hash >::find(), HashTable< Pair< autoPtr< interfaceCompositionModel > >, phasePairKey, phasePairKey::hash >::find(), patchProbes::findElements(), fileOperation::findInstance(), mappedPatchBase::findSamples(), MeshZones< cellZone, polyMesh >::findZoneID(), ListHashTable< T, Key, Hash >::found(), HashTable< Pair< autoPtr< interfaceCompositionModel > >, phasePairKey, phasePairKey::hash >::found(), ddtScheme< Type >::fvcDdtPhiCoeff(), fvMatrix< Type >::fvMatrix(), GeometricField< vector, pointPatchField, pointMesh >::GeometricField(), IFstream::IFstream(), interpolationCellPointFace< Type >::interpolate(), surfaceInterpolationScheme< GType >::interpolate(), IOobject::IOobject(), IOobjectList::lookup(), IOobjectList::lookupClass(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::meshEdges(), polyMesh::movePoints(), fileOperationInitialise::New(), blockVertex::New(), interpolationWeights::New(), thermophysicalProperties::New(), snGradScheme< Type >::New(), blockFace::New(), gradScheme< Type >::New(), ddtScheme< Type >::New(), d2dt2Scheme< Type >::New(), surfaceInterpolationScheme< GType >::New(), divScheme< Type >::New(), GAMGProcAgglomeration::New(), fvPatch::New(), solidProperties::New(), facePointPatch::New(), blockEdge::New(), convectionScheme< Type >::New(), multivariateSurfaceInterpolationScheme< Type >::New(), polyMeshModifier::New(), block::New(), limitedSurfaceInterpolationScheme< Type >::New(), liquidProperties::New(), laplacianScheme< Type, GType >::New(), cellZone::New(), coordinateSystem::New(), pointZone::New(), pointPatchField< vector >::New(), UnsortedMeshedSurface< Face >::New(), faceZone::New(), fvsPatchField< Type >::New(), fvPatchField< Type >::New(), MeshedSurface< Foam::face >::New(), polyPatch::New(), OFstream::OFstream(), dlLibraryTable::open(), dictionary::read(), Foam::readDir(), GeometricField< Type, PatchField, GeoMesh >::Boundary::readField(), functionObjectList::readFunctionObject(), uncollatedFileOperation::readHeader(), IOobject::readHeader(), regIOobject::readHeaderOk(), surfMesh::readUpdate(), polyMesh::readUpdate(), fvMatrix< Type >::relax(), GeometricField< vector, pointPatchField, pointMesh >::relax(), polyMesh::removeBoundary(), surfMesh::removeZones(), ListHashTable< T, Key, Hash >::resize(), HashTable< Pair< autoPtr< interfaceCompositionModel > >, phasePairKey, phasePairKey::hash >::resize(), searchablePlate::searchablePlate(), IOobject::setBad(), surfMesh::setInstance(), polyMesh::setInstance(), HashTable< Pair< autoPtr< interfaceCompositionModel > >, phasePairKey, phasePairKey::hash >::sortedToc(), MeshedSurface< Foam::face >::stitchFaces(), GeometricField< vector, pointPatchField, pointMesh >::storeOldTime(), GeometricField< vector, pointPatchField, pointMesh >::storePrevIter(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::surfaceType(), thermo< Thermo, Type >::T(), timer::timer(), ListHashTable< T, Key, Hash >::toc(), mixerFvMesh::update(), GeometricField< Type, PatchField, GeoMesh >::Boundary::updateCoeffs(), polyMesh::updateMesh(), UpwindFitData< Polynomial >::UpwindFitData(), fvMesh::V(), fvMesh::V00(), wallLayerCells::wallLayerCells(), ParticleTracks< CloudType >::write(), MeshedSurfaceProxy< Face >::write(), edgeMesh::write(), UnsortedMeshedSurface< Face >::write(), MeshedSurface< Foam::face >::write(), IOobject::writeHeader(), dlLibraryTable::~dlLibraryTable(), fvMatrix< Type >::~fvMatrix(), leastSquaresVectors::~leastSquaresVectors(), LeastSquaresVectors< Stencil >::~LeastSquaresVectors(), skewCorrectionVectors::~skewCorrectionVectors(), and timer::~timer().

◆ InfoHeader

#define InfoHeader   if (::Foam::writeInfoHeader) Info

◆ Log

◆ IOInfoIn

#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 296 of file messageStream.H.

◆ IOInfoInFunction

#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 302 of file messageStream.H.

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

◆ DebugInfo

#define DebugInfo   if (debug) Info

◆ DebugInFunction

#define DebugInFunction   if (debug) InfoInFunction

Report an information message using Foam::Info.

for FUNCTION_NAME in file __FILE__ at line __LINE__ if the local debug switch is true

Definition at line 313 of file messageStream.H.

Referenced by thermoSingleLayer::addSources(), kinematicSingleLayer::addSources(), nearWallFields::calcAddressing(), kinematicSingleLayer::constrainFilmField(), thermoSingleLayer::evolveRegion(), kinematicSingleLayer::evolveRegion(), nearWallFields::execute(), rigidBodyModel::forwardDynamics(), rigidBodyModel::forwardDynamicsCorrection(), kinematicSingleLayer::predictDelta(), thermoSingleLayer::preEvolveRegion(), kinematicSingleLayer::preEvolveRegion(), thermoSingleLayer::resetPrimaryRegionSourceTerms(), kinematicSingleLayer::resetPrimaryRegionSourceTerms(), kinematicSingleLayer::solveAlpha(), thermalBaffle::solveEnergy(), thermoSingleLayer::solveEnergy(), kinematicSingleLayer::solveMomentum(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), thermoSingleLayer::transferPrimaryRegionThermoFields(), kinematicSingleLayer::transferPrimaryRegionThermoFields(), multiMotion::transformation(), linearMotion::transformation(), oscillatingLinearMotion::transformation(), axisRotationMotion::transformation(), oscillatingRotatingMotion::transformation(), rotatingMotion::transformation(), sixDoFMotion::transformation(), SDA::transformation(), thermoSingleLayer::updateSubmodels(), kinematicSingleLayer::updateSubmodels(), nearWallFields::write(), and nearWallFields::~nearWallFields().

◆ DebugVar

#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:251
const string & prefix() const
Return the prefix of the stream.
prefixOSstream Pout(cout, "Pout")
Definition: IOstreams.H:53
A class for handling character strings derived from std::string.
Definition: string.H:76

Report a variable name and value.

using Foam::Pout in file __FILE__ at line __LINE__

Definition at line 318 of file messageStream.H.