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 a information message using Foam::Info. More...
 
#define InfoInFunction   InfoIn(FUNCTION_NAME)
 Report a information message using Foam::Info. 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 Debug(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__)
#define SeriousErrorInFunction   SeriousErrorIn(FUNCTION_NAME)

Report an error message using Foam::SeriousError.

for FUNCTION_NAME in file __FILE__ at line __LINE__

Definition at line 237 of file messageStream.H.

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

Referenced by IOobject::readHeader().

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

#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 polyTopoChange::addMesh(), faceZoneSet::addSet(), fileMonitor::addWatch(), polyMeshGeometry::affectedCells(), manualGAMGProcAgglomeration::agglomerate(), searchableSurfaceToFaceZone::applyToSet(), faceZoneToFaceZone::applyToSet(), setToCellZone::applyToSet(), setToPointZone::applyToSet(), setToFaceZone::applyToSet(), setAndNormalToFaceZone::applyToSet(), setsToFaceZone::applyToSet(), fieldToCell::applyToSet(), ash::ash(), Foam::average(), bufferedAccumulator< Type >::averaged(), blendingFactor::blendingFactor(), booleanSurface::booleanSurface(), C::C(), cachedRandom::cachedRandom(), CaCO3::CaCO3(), Foam::meshTools::calcBoxPointNormals(), polyDualMesh::calcFeatures(), CentredFitSnGradData< Polynomial >::calcFit(), FitData< FitDataType, ExtendedStencil, Polynomial >::calcFit(), forces::calcForcesMoment(), calcFvcDiv::calcFvcDiv(), calcFvcGrad::calcFvcGrad(), wedgePolyPatch::calcGeometry(), calcMag::calcMag(), mappedPatchBase::calcMapping(), autoSnapDriver::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(), turbulenceFields::compressible(), IOstream::compressionEnum(), ConstantRateDevolatilisation< CloudType >::ConstantRateDevolatilisation(), CourantNo::CourantNo(), hexCellLooper::cut(), structuredDecomp::decompose(), faceZoneSet::deleteSet(), directionMixedFvPatchField< Type >::directionMixedFvPatchField(), directions::directions(), Foam::dlOpen(), Foam::dlSym(), autoLayerDriver::doLayers(), autoSnapDriver::doSnap(), dsmcFields::dsmcFields(), greyMeanAbsorptionEmission::ECont(), wideBandAbsorptionEmission::ECont(), Foam::eigenValues(), SpalartAllmaras< BasicTurbulenceModel >::epsilon(), calcMag::execute(), calcFvcDiv::execute(), calcFvcGrad::execute(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), polyMeshTetDecomposition::faceTetIndices(), extendedEdgeMesh::featurePointNormals(), fieldAverage::fieldAverage(), fieldCoordinateSystemTransform::fieldCoordinateSystemTransform(), fieldMinMax::fieldMinMax(), fieldValue::fieldValue(), functionObjectFile::file(), fileMonitorWatcher::fileMonitorWatcher(), IOobject::fileNameComponents(), patchProbes::findElements(), probes::findElements(), indexedOctree< Type >::findLine(), polyTopoChanger::findModifierID(), dynamicIndexedOctree< Type >::findNearest(), fixedGradientFvPatchField< Type >::fixedGradientFvPatchField(), fixedValueFvPatchField< Type >::fixedValueFvPatchField(), forces::forces(), IOstream::formatEnum(), Foam::gAverage(), hexRef8::getAnchorLevel(), 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(), forces::initialise(), cellSource::initialise(), faceSource::initialise(), fieldAverage::initialize(), faceAreaWeightAMI< SourcePatch, TargetPatch >::interArea(), interpolation2DTable< Type >::interpolation2DTable(), IOdictionary::IOdictionary(), IOField< Type >::IOField(), IOList< T >::IOList(), IOmapDistribute::IOmapDistribute(), CompositionModel< CloudType >::L(), Lambda2::Lambda2(), lduPrimitiveMesh::lduPrimitiveMesh(), janafThermo< EquationOfState >::limit(), LiquidEvaporation< CloudType >::LiquidEvaporation(), LiquidEvaporationBoil< CloudType >::LiquidEvaporationBoil(), Foam::ln(), cellModel::mag(), fvMeshAdder::MapSurfaceFields(), fvMeshAdder::MapVolFields(), meshToMesh0::meshToMesh0(), meshTriangulation::meshTriangulation(), mixedFvPatchField< Type >::mixedFvPatchField(), motionSmootherAlgo::modifyMotionPoints(), wallDist::n(), NamedEnum< Enum, nEnum >::names(), nearWallFields::nearWallFields(), 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(), PatchPostProcessing< CloudType >::PatchPostProcessing(), polyBoundaryMesh::patchSet(), Peclet::Peclet(), polyBoundaryMesh::polyBoundaryMesh(), polyMesh::polyMesh(), Foam::polyMeshZipUpCells(), PolynomialEntry< Type >::PolynomialEntry(), pressureTools::pressureTools(), turbulenceFields::processField(), processorCyclicFvPatchField< Type >::processorCyclicFvPatchField(), processorField::processorField(), liquidMixtureProperties::pvInvert(), liquidProperties::pvInvert(), Q::Q(), interpolationTable< Type >::rateOfChange(), AC3DsurfaceFormat< Face >::read(), systemCall::read(), wallShearStress::read(), probes::read(), wallBoundedStreamLine::read(), pressureTools::read(), Time::readDict(), readFields::readFields(), surfMesh::readUpdate(), polyMesh::readUpdate(), Foam::readUpto(), dynamicRefineFvMesh::refine(), refinementHistory::refinementHistory(), regionSizeDistribution::regionSizeDistribution(), structuredRenumber::renumber(), residuals::residuals(), thermalBaffleFvPatchScalarField::rmap(), Foam::rmDir(), timeSelector::select0(), InteractionLists< ParticleType >::sendReferredData(), cellSetOption::setCellSet(), cellSizeFunction::setCellSize(), ReactingParcel< ParcelType >::setCellValues(), ThermoParcel< ParcelType >::setCellValues(), KinematicParcel< ParcelType >::setCellValues(), Time::setControls(), cyclicACMIPolyPatch::setNeighbourFaceAreas(), removeCells::setRefinement(), refinementIterator::setRefinement(), perfectInterface::setRefinement(), removeFaces::setRefinement(), sigmaRadial::sigmaRadial(), SingleKineticRateDevolatilisation< CloudType >::SingleKineticRateDevolatilisation(), seulex::solve(), PatchTools::sortedPointEdges(), splineInterpolationWeights::splineInterpolationWeights(), meshRefinement::splitMeshRegions(), streamLine::streamLine(), faceZoneSet::subset(), hexRef8::subset(), surfaceInterpolateFields::surfaceInterpolateFields(), surfaceIntersection::surfaceIntersection(), surfacePatchIOList::surfacePatchIOList(), SVD::SVD(), TAB< CloudType >::TAB(), polyMesh::tetBasePtIs(), thresholdCellFaces::thresholdCellFaces(), distribution::totalEntries(), triSurfaceSearch::tree(), treeBoundBox::treeBoundBox(), polyMeshTetDecomposition::triangleTetIndices(), turbulenceFields::turbulenceFields(), dynamicRefineFvMesh::unrefine(), multiSolidBodyMotionFvMesh::update(), solidBodyMotionFvMesh::update(), inclinedFilmNusseltHeightFvPatchScalarField::updateCoeffs(), inclinedFilmNusseltInletVelocityFvPatchVectorField::updateCoeffs(), edgeVertex::updateLabels(), CellZoneInjection< CloudType >::updateMesh(), fileMonitor::updateStates(), vorticity::vorticity(), wallBoundedStreamLine::wallBoundedStreamLine(), wallShearStress::wallShearStress(), CocoParserErrors< BaseClass, StringClass >::Warning(), interpolation2DTable< Type >::wordToBoundsHandling(), TableBase< Type >::wordToBoundsHandling(), interpolationTable< Type >::wordToBoundsHandling(), writeRegisteredObject::write(), graph::write(), oldCyclicPolyPatch::write(), cellSource::write(), dictionary::write(), faceSource::write(), interpolation2DTable< Type >::Xi(), yPlus::yPlus(), absorptionCoeffs::~absorptionCoeffs(), and fileMonitorWatcher::~fileMonitorWatcher().

#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 meshRefinement::mergeBaffles(), patchInteractionDataList::patchInteractionDataList(), and meshRefinement::splitMesh().

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

Report an IO warning using Foam::Warning.

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

Definition at line 271 of file messageStream.H.

#define InfoIn (   functionName)    ::Foam::Info((functionName), __FILE__, __LINE__)

Report a information message using Foam::Info.

for functionName in file __FILE__ at line __LINE__

Definition at line 276 of file messageStream.H.

Referenced by viewFactor::calculate(), interpolationWeights::New(), fvMatrix< Type >::relax(), GeometricField< Type, PatchField, GeoMesh >::relax(), solution::solver(), and solution::solverDict().

#define InfoInFunction   InfoIn(FUNCTION_NAME)

Report a information message using Foam::Info.

for FUNCTION_NAME in file __FILE__ at line __LINE__

Definition at line 281 of file messageStream.H.

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

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

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

#define Debug (   var)
Value:
::Foam::Pout<< "["<< __FILE__ << ":" << __LINE__ << "] " \
<< #var " " << var << ::Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
prefixOSstream Pout(cout,"Pout")
Definition: IOstreams.H:53

Report a variable name and value.

using Foam::Pout in file __FILE__ at line __LINE__

Definition at line 298 of file messageStream.H.

Referenced by energyRegionCoupledFvPatchScalarField::snGrad().