A surfaceWriter for outputting to a form usable for the timeVaryingMapped boundary condition. This reads the data from constant/boundaryData/<patch> directory. More...

Inheritance diagram for boundaryDataWriter:

[legend]

Collaboration diagram for boundaryDataWriter:

[legend]

Public Member Functions
	TypeNameNoDebug ("boundaryData")

	boundaryDataWriter ()

	boundaryDataWriter (const dictionary &options)

	boundaryDataWriter (const meshedSurf &surf, const fileName &outputPath, bool parallel=Pstream::parRun(), const dictionary &options=dictionary())

	boundaryDataWriter (const pointField &points, const faceList &faces, const fileName &outputPath, bool parallel=Pstream::parRun(), const dictionary &options=dictionary())

virtual	~boundaryDataWriter ()=default

virtual fileName	write ()

	declareSurfaceWriterWriteMethod (label)

	declareSurfaceWriterWriteMethod (scalar)

	declareSurfaceWriterWriteMethod (vector)

	declareSurfaceWriterWriteMethod (sphericalTensor)

	declareSurfaceWriterWriteMethod (symmTensor)

	declareSurfaceWriterWriteMethod (tensor)

template<class Type >
Foam::fileName	writeTemplate (const word &fieldName, const Field< Type > &localValues)

Public Member Functions inherited from surfaceWriter
	TypeName ("surfaceWriter")

	declareRunTimeSelectionTable (autoPtr, surfaceWriter, word,(),())

	declareRunTimeSelectionTable (autoPtr, surfaceWriter, wordDict,(const dictionary &writeOpts),(writeOpts))

	surfaceWriter ()

	surfaceWriter (const dictionary &options)

	surfaceWriter (const meshedSurf &surf, bool parallel=Pstream::parRun(), const dictionary &options=dictionary())

	surfaceWriter (const pointField &points, const faceList &faces, bool parallel=Pstream::parRun(), const dictionary &options=dictionary())

virtual	~surfaceWriter ()

virtual bool	enabled () const

virtual bool	separateGeometry () const

virtual bool	usesFaceIds () const

virtual bool	needsUpdate () const

virtual bool	wroteData () const

virtual bool	expire ()

virtual void	clear ()

virtual void	setSurface (const meshedSurf &surf, bool parallel)

virtual void	setSurface (const pointField &points, const faceList &faces, bool parallel)

virtual void	setSurface (const meshedSurf &surf)

virtual void	setSurface (const pointField &points, const faceList &faces)

bool	hasSurface () const

bool	empty () const

label	size () const

label	nFields () const

label	nFields (const label n)

bool	isPointData () const

bool	isPointData (const bool on)

bool	useTimeDir () const

bool	useTimeDir (const bool on)

bool	verbose () const

bool	verbose (const bool on)

scalar	mergeDim () const

scalar	mergeDim (const scalar dist)

bool	hasTime () const

const word &	timeName () const

scalar	timeValue () const

void	setTime (const instant &inst)

void	setTime (scalar timeValue)

void	setTime (scalar timeValue, const word &timeName)

void	unsetTime ()

virtual void	beginTime (const Time &t)

virtual void	beginTime (const instant &inst)

virtual void	endTime ()

virtual void	open (const fileName &outputPath)

virtual void	open (const pointField &points, const faceList &faces, const fileName &outputPath, bool parallel)

virtual void	open (const meshedSurf &surf, const fileName &outputPath, bool parallel)

virtual void	open (const pointField &points, const faceList &faces, const fileName &outputPath)

virtual void	open (const meshedSurf &surf, const fileName &outputPath)

virtual void	close ()

virtual fileName	write (const word &fieldName, const Field< label > &values)=0
	Write field of label (per face or vertex) More...

virtual fileName	write (const word &fieldName, const Field< scalar > &values)=0
	Write field of scalar (per face or vertex) More...

virtual fileName	write (const word &fieldName, const Field< vector > &values)=0
	Write field of vector (per face or vertex) More...

virtual fileName	write (const word &fieldName, const Field< sphericalTensor > &values)=0
	Write field of sphericalTensor (per face or vertex) More...

virtual fileName	write (const word &fieldName, const Field< symmTensor > &values)=0
	Write field of symmTensor (per face or vertex) More...

virtual fileName	write (const word &fieldName, const Field< tensor > &values)=0
	Write field of tensor (per face or vertex) More...

virtual InfoProxy< surfaceWriter >	info () const

template<class Type >
Foam::tmp< Foam::Field< Type > >	mergeFieldTemplate (const Field< Type > &fld) const

Additional Inherited Members
Static Public Member Functions inherited from surfaceWriter
static bool	supportedType (const word &writeType)

static autoPtr< surfaceWriter >	New (const word &writeType)

static autoPtr< surfaceWriter >	New (const word &writeType, const dictionary &writeOptions)

Static Public Attributes inherited from surfaceWriter
static scalar	defaultMergeDim = 1e-8

Protected Member Functions inherited from surfaceWriter
bool	checkOpen () const

virtual bool	merge () const

const meshedSurf &	surface () const

template<class Type >
tmp< Field< Type > >	mergeFieldTemplate (const Field< Type > &fld) const

tmp< Field< label > >	mergeField (const Field< label > &fld) const

tmp< Field< scalar > >	mergeField (const Field< scalar > &fld) const

tmp< Field< vector > >	mergeField (const Field< vector > &fld) const

tmp< Field< sphericalTensor > >	mergeField (const Field< sphericalTensor > &fld) const

tmp< Field< symmTensor > >	mergeField (const Field< symmTensor > &fld) const

tmp< Field< tensor > >	mergeField (const Field< tensor > &fld) const

template<class Type >
fileName	writeTemplate (const word &fieldName, const Field< Type > &localValues)

Protected Attributes inherited from surfaceWriter
std::reference_wrapper< const meshedSurf >	surf_

meshedSurfRef	surfComp_

bool	useComponents_

bool	upToDate_

bool	wroteGeom_

bool	parallel_

bool	useTimeDir_

bool	isPointData_

bool	verbose_

label	nFields_

scalar	mergeDim_

mergedSurf	merged_

instant	currTime_

fileName	outputPath_

Static Protected Attributes inherited from surfaceWriter
static const meshedSurf::emptySurface	emptySurface_

Detailed Description

A surfaceWriter for outputting to a form usable for the timeVaryingMapped boundary condition. This reads the data from constant/boundaryData/<patch> directory.

formatOptions
{
    boundaryData
    {
        header      false;
        format      ascii;
        compression false;
    }
}

Format options:

Property	Description	Required	Default
`header`	Generate files with FoamFile header	no	true
`format`	ascii/binary	no	ascii
`compression`	Use file compression	no	false
`fieldScale`	output field scaling (dictionary)	no	empty

Typical way of working:

use a sampledSurface of type 'patch' (to sample a patch):

    surfaces
    {
        type            surfaces;
        fields          ( p );
        surfaceFormat   boundaryData;
        formatOptions
        {
            boundaryData
            {
                format  binary;
                fieldScale
                {
                   "p.*"   0.01;  // [Pa] -> [mbar]
                }
            }
        }
        surfaces
        {
            outlet
            {
                type            patch;
                patches         (outlet);
                interpolate     false;
            }
        }
    }

write using this writer.
move postProcessing/surfaces/outlet to constant/boundaryData/outlet in your destination case.
use a timeVaryingMappedFixedValue condition to read and interpolate the profile: type timeVaryingMappedFixedValue; setAverage false; // do not use read average offset 0; // do not apply offset to values

Note:

with 'interpolate false' the data is on the face centres of the patch. Take care that a 2D geometry will only have a single row of face centres so might not provide a valid triangulation (this is what timeVaryingMappedFixedValue uses to do interpolation) (Alternatively use timeVaryingMappedFixedValue with mapMethod 'nearest')

Output file locations

The rootdir normally corresponds to something like postProcessing/<name>

where the geometry is written as:

    rootdir
    `-- surfaceName
        `-- "points"

and field data:

    rootdir
    `-- surfaceName
        |-- "points"
        `-- timeName
            `-- field

Source files

Definition at line 168 of file boundaryDataSurfaceWriter.H.

Constructor & Destructor Documentation

◆ boundaryDataWriter() [1/4]

boundaryDataWriter ( )

Definition at line 48 of file boundaryDataSurfaceWriter.C.

◆ boundaryDataWriter() [2/4]

boundaryDataWriter ( const dictionary & options )

explicit

Definition at line 58 of file boundaryDataSurfaceWriter.C.

◆ boundaryDataWriter() [3/4]

boundaryDataWriter	(	const meshedSurf &	surf,
		const fileName &	outputPath,
		bool	parallel = `Pstream::parRun()`,
		const dictionary &	options = `dictionary()`
	)

Definition at line 74 of file boundaryDataSurfaceWriter.C.

◆ boundaryDataWriter() [4/4]

boundaryDataWriter	(	const pointField &	points,
		const faceList &	faces,
		const fileName &	outputPath,
		bool	parallel = `Pstream::parRun()`,
		const dictionary &	options = `dictionary()`
	)