This boundary condition provides an advective outflow condition, based on solving DDt(psi, U) = 0 at the boundary. More...

Inheritance diagram for advectiveFvPatchField< Type >:

[legend]

Collaboration diagram for advectiveFvPatchField< Type >:

[legend]

Public Member Functions
	TypeName ("advective")
	Runtime type information. More...

	advectiveFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	advectiveFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	advectiveFvPatchField (const advectiveFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given advectiveFvPatchField. More...

	advectiveFvPatchField (const advectiveFvPatchField &)
	Construct as copy. More...

virtual tmp< fvPatchField< Type > >	clone () const
	Construct and return a clone. More...

	advectiveFvPatchField (const advectiveFvPatchField &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

const Type &	fieldInf () const
	Return the field at infinity. More...

Type &	fieldInf ()
	Return reference to the field at infinity to allow adjustment. More...

scalar	lInf () const
	Return the relaxation length-scale. More...

scalar &	lInf ()
	Return reference to the relaxation length-scale. More...

virtual tmp< scalarField >	advectionSpeed () const
	Calculate and return the advection speed at the boundary. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual void	write (Ostream &) const
	Write. More...

Public Member Functions inherited from mixedFvPatchField< Type >
	TypeName ("mixed")
	Runtime type information. More...

	mixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	mixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	mixedFvPatchField (const mixedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given mixedFvPatchField onto a new patch. More...

	mixedFvPatchField (const mixedFvPatchField< Type > &)
	Construct as copy. More...

	mixedFvPatchField (const mixedFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual Field< Type > &	refValue ()

virtual const Field< Type > &	refValue () const

virtual Field< Type > &	refGrad ()

virtual const Field< Type > &	refGrad () const

virtual scalarField &	valueFraction ()

virtual const scalarField &	valueFraction () const

virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const fvPatchField< Type > &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

virtual tmp< Field< Type > >	snGrad () const
	Return gradient at boundary. More...

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Evaluate the patch field. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

virtual void	operator= (const UList< Type > &)

virtual void	operator= (const fvPatchField< Type > &)

virtual void	operator+= (const fvPatchField< Type > &)

virtual void	operator-= (const fvPatchField< Type > &)

virtual void	operator*= (const fvPatchField< scalar > &)

virtual void	operator/= (const fvPatchField< scalar > &)

virtual void	operator+= (const Field< Type > &)

virtual void	operator-= (const Field< Type > &)

virtual void	operator*= (const Field< scalar > &)

virtual void	operator/= (const Field< scalar > &)

virtual void	operator= (const Type &)

virtual void	operator+= (const Type &)

virtual void	operator-= (const Type &)

virtual void	operator*= (const scalar)

virtual void	operator/= (const scalar)

Public Member Functions inherited from fvPatchField< Type >
	TypeName ("fvPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, fvPatchField, patch,( const fvPatch &p, const DimensionedField< Type, volMesh > &iF ),(p, iF))

	declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,( const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m ),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,( const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict ),(p, iF, dict))

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
	Construct from patch and internal field and patch type. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=false)
	Construct from patch, internal field and dictionary. More...

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fvPatchField onto a new patch. More...

	fvPatchField (const fvPatchField< Type > &)
	Construct as copy. More...

	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual	~fvPatchField ()
	Destructor. More...

const objectRegistry &	db () const
	Return local objectRegistry. More...

const fvPatch &	patch () const
	Return patch. More...

const DimensionedField< Type, volMesh > &	dimensionedInternalField () const
	Return dimensioned internal field reference. More...

const Field< Type > &	internalField () const
	Return internal field reference. More...

const word &	patchType () const
	Optional patch type. More...

word &	patchType ()
	Optional patch type. More...

virtual bool	coupled () const
	Return true if this patch field is coupled. More...

bool	updated () const
	Return true if the boundary condition has already been updated. More...

bool	manipulatedMatrix () const
	Return true if the matrix has already been manipulated. More...

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const
	Return patch-normal gradient for coupled-patches. More...

virtual void	updateCoeffs (const scalarField &weights)
	Update the coefficients associated with the patch field. More...

virtual tmp< Field< Type > >	patchInternalField () const
	Return internal field next to patch as patch field. More...

virtual void	patchInternalField (Field< Type > &) const
	Return internal field next to patch as patch field. More...

virtual tmp< Field< Type > >	patchNeighbourField () const
	Return patchField on the opposite patch of a coupled patch. More...

virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Initialise the evaluation of the patch field. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix source coefficients corresponding to the. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)
	Manipulate matrix. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
	Manipulate matrix with given weights. More...

template<class EntryType >
void	writeEntryIfDifferent (Ostream &os, const word &entryName, const EntryType &value1, const EntryType &value2) const
	Helper function to write the keyword and entry only if the. More...

void	check (const fvPatchField< Type > &) const
	Check fvPatchField<Type> against given fvPatchField<Type> More...

virtual void	operator== (const fvPatchField< Type > &)

virtual void	operator== (const Field< Type > &)

virtual void	operator== (const Type &)

template<class Type2 >
Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &pf)

Public Member Functions inherited from Field< Type >
	Field ()
	Construct null. More...

	Field (const label)
	Construct given size. More...

	Field (const label, const Type &)
	Construct given size and initial value. More...

	Field (const UList< Type > &)
	Construct as copy of a UList<Type> More...

	Field (const Xfer< List< Type > > &)
	Construct by transferring the List contents. More...

	Field (const UList< Type > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field. More...

	Field (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given tmp field. More...

	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field. More...

	Field (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given tmp field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map)
	Construct by mapping from the given field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue)
	Construct by mapping from the given field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues)
	Construct by mapping from the given field. More...

	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map)
	Construct by mapping from the given tmp field. More...

	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const Type &defaultValue)
	Construct by mapping from the given tmp field. Supplied uniform. More...

	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const UList< Type > &defaultValues)
	Construct by mapping from the given tmp field. Supplied values. More...

	Field (const Field< Type > &)
	Construct as copy. More...

	Field (Field< Type > &, bool reUse)
	Construct as copy or re-use as specified. More...

	Field (const Xfer< Field< Type > > &)
	Construct by transferring the Field contents. More...

	Field (const tmp< Field< Type > > &)
	Construct as copy of tmp<Field> More...

	Field (Istream &)
	Construct from Istream. More...

	Field (const word &keyword, const dictionary &, const label size)
	Construct from a dictionary entry. More...

tmp< Field< Type > >	clone () const
	Clone. More...

void	map (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field More...

void	map (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	1 to 1 map from the given tmp field More...

void	map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given field. More...

void	map (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given tmp field. More...

void	map (const UList< Type > &mapF, const FieldMapper &map)
	Map from the given field. More...

void	map (const tmp< Field< Type > > &tmapF, const FieldMapper &map)
	Map from the given tmp field. More...

void	autoMap (const FieldMapper &map)
	Map from self. More...

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field More...

void	rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field More...

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field. More...

void	rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field. More...

void	negate ()
	Negate this field. More...

tmp< Field< cmptType > >	component (const direction) const
	Return a component field of the field. More...

void	replace (const direction, const UList< cmptType > &)
	Replace a component field of the field. More...

void	replace (const direction, const tmp< Field< cmptType > > &)
	Replace a component field of the field. More...

void	replace (const direction, const cmptType &)
	Replace a component field of the field. More...

tmp< Field< Type > >	T () const
	Return the field transpose (only defined for second rank tensors) More...

void	writeEntry (const word &keyword, Ostream &os) const
	Write the field as a dictionary entry. More...

void	operator= (const Field< Type > &)

void	operator= (const UList< Type > &)

void	operator= (const SubField< Type > &)

void	operator= (const tmp< Field< Type > > &)

void	operator= (const Type &)

template<class Form , class Cmpt , int nCmpt>
void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)

void	operator+= (const UList< Type > &)

void	operator+= (const tmp< Field< Type > > &)

void	operator-= (const UList< Type > &)

void	operator-= (const tmp< Field< Type > > &)

void	operator*= (const UList< scalar > &)

void	operator*= (const tmp< Field< scalar > > &)

void	operator/= (const UList< scalar > &)

void	operator/= (const tmp< Field< scalar > > &)

void	operator+= (const Type &)

void	operator-= (const Type &)

void	operator*= (const scalar &)

void	operator/= (const scalar &)

template<class Type>
void	operator= (const tmp< Field > &rhs)

Public Member Functions inherited from refCount
	refCount ()
	Construct null with zero count. More...

int	count () const
	Return the reference count. More...

bool	okToDelete () const
	Return true if the reference count is zero. More...

void	resetRefCount ()
	Reset the reference count to zero. More...

void	operator++ ()
	Increment the reference count. More...

void	operator++ (int)
	Increment the reference count. More...

void	operator-- ()
	Decrement the reference count. More...

void	operator-- (int)
	Decrement the reference count. More...

Public Member Functions inherited from List< Type >
label	size () const
	Return the number of elements in the UList. More...

	List ()
	Null constructor. More...

	List (const label)
	Construct with given size. More...

	List (const label, const Type &)
	Construct with given size and value for all elements. More...

	List (const List< Type > &)
	Copy constructor. More...

	List (const Xfer< List< Type > > &)
	Construct by transferring the parameter contents. More...

	List (List< Type > &, bool reUse)
	Construct as copy or re-use as specified. More...

	List (const UList< Type > &, const labelUList &mapAddressing)
	Construct as subset. More...

	List (InputIterator first, InputIterator last)
	Construct given start and end iterators. More...

	List (const FixedList< Type, Size > &)
	Construct as copy of FixedList<T, Size> More...

	List (const PtrList< Type > &)
	Construct as copy of PtrList<T> More...

	List (const SLList< Type > &)
	Construct as copy of SLList<T> More...

	List (const UIndirectList< Type > &)
	Construct as copy of UIndirectList<T> More...

	List (const BiIndirectList< Type > &)
	Construct as copy of BiIndirectList<T> More...

	List (Istream &)
	Construct from Istream. More...

autoPtr< List< Type > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

void	resize (const label)
	Alias for setSize(const label) More...

void	resize (const label, const Type &)
	Alias for setSize(const label, const T&) More...

void	setSize (const label)
	Reset size of List. More...

void	setSize (const label, const Type &)
	Reset size of List and value for new elements. More...

void	clear ()
	Clear the list, i.e. set size to zero. More...

void	append (const Type &)
	Append an element at the end of the list. More...

void	append (const UList< Type > &)
	Append a List at the end of this list. More...

void	append (const UIndirectList< Type > &)
	Append a UIndirectList at the end of this list. More...

void	transfer (List< Type > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (DynamicList< Type, SizeInc, SizeMult, SizeDiv > &)
	Transfer the contents of the argument List into this list. More...

void	transfer (SortableList< Type > &)
	Transfer the contents of the argument List into this list. More...

Xfer< List< Type > >	xfer ()
	Transfer contents to the Xfer container. More...

Type &	newElmt (const label)
	Return subscript-checked element of UList. More...

void	operator= (const UList< Type > &)
	Assignment from UList operator. Takes linear time. More...

void	operator= (const List< Type > &)
	Assignment operator. Takes linear time. More...

void	operator= (const SLList< Type > &)
	Assignment from SLList operator. Takes linear time. More...

void	operator= (const UIndirectList< Type > &)
	Assignment from UIndirectList operator. Takes linear time. More...

void	operator= (const BiIndirectList< Type > &)
	Assignment from BiIndirectList operator. Takes linear time. More...

void	operator= (const Type &)
	Assignment of all entries to the given value. More...

Public Member Functions inherited from UList< Type >
	UList ()
	Null constructor. More...

	UList (Type *__restrict__ v, label size)
	Construct from components. More...

label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index. More...

label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index. More...

std::streamsize	byteSize () const
	Return the binary size in number of characters of the UList. More...

const Type *	cdata () const
	Return a const pointer to the first data element,. More...

Type *	data ()
	Return a pointer to the first data element,. More...

Type &	first ()
	Return the first element of the list. More...

const Type &	first () const
	Return first element of the list. More...

Type &	last ()
	Return the last element of the list. More...

const Type &	last () const
	Return the last element of the list. More...

void	checkStart (const label start) const
	Check start is within valid range (0 ... size-1). More...

void	checkSize (const label size) const
	Check size is within valid range (0 ... size). More...

void	checkIndex (const label i) const
	Check index i is within valid range (0 ... size-1). More...

void	writeEntry (Ostream &) const
	Write the UList as a dictionary entry. More...

void	writeEntry (const word &keyword, Ostream &) const
	Write the UList as a dictionary entry with keyword. More...

void	assign (const UList< Type > &)
	Assign elements to those from UList. More...

Type &	operator[] (const label)
	Return element of UList. More...

const Type &	operator[] (const label) const
	Return element of constant UList. More...

	operator const Foam::List< Type > & () const
	Allow cast to a const List<T>&. More...

void	operator= (const Type &)
	Assignment of all entries to the given value. More...

iterator	begin ()
	Return an iterator to begin traversing the UList. More...

const_iterator	begin () const
	Return const_iterator to begin traversing the constant UList. More...

iterator	end ()
	Return an iterator to end traversing the UList. More...

const_iterator	end () const
	Return const_iterator to end traversing the constant UList. More...

const_iterator	cbegin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const
	Return const_iterator to end traversing the constant UList. More...

reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

label	size () const
	Return the number of elements in the UList. More...

label	max_size () const
	Return size of the largest possible UList. More...

bool	empty () const
	Return true if the UList is empty (ie, size() is zero). More...

void	swap (UList< Type > &)
	Swap two ULists of the same type in constant time. More...

bool	operator== (const UList< Type > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< Type > &) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< Type > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< Type > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< Type > &) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< Type > &) const
	Return true if !(a < b). Takes linear time. More...

Protected Attributes
word	phiName_
	Name of the flux transporting the field. More...

word	rhoName_
	Name of the density field used to normalise the mass flux. More...

Type	fieldInf_
	Field value of the far-field. More...

scalar	lInf_
	Relaxation length-scale. More...

Additional Inherited Members
Public Types inherited from fvPatchField< Type >
typedef fvPatch	Patch

Public Types inherited from Field< Type >
typedef pTraits< Type >::cmptType	cmptType
	Component type. More...

typedef SubField< Type >	subField
	Declare type of subField. More...

Public Types inherited from List< Type >
typedef SubList< Type >	subList
	Declare type of subList. More...

Public Types inherited from UList< Type >
typedef Type	value_type
	Type of values the UList contains. More...

typedef Type &	reference
	Type that can be used for storing into. More...

typedef const Type &	const_reference
	Type that can be used for storing into. More...

typedef label	difference_type
	The type that can represent the difference between any two. More...

typedef label	size_type
	The type that can represent the size of a UList. More...

typedef Type *	iterator
	Random access iterator for traversing UList. More...

typedef const Type *	const_iterator
	Random access iterator for traversing UList. More...

typedef Type *	reverse_iterator
	Reverse iterator for reverse traversal of UList. More...

typedef const Type *	const_reverse_iterator
	Reverse iterator for reverse traversal of constant UList. More...

Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)
	Return a pointer to a new calculatedFvPatchField created on. More...

template<class Type2 >
static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)
	Return a pointer to a new calculatedFvPatchField created on. More...

static const word &	calculatedType ()
	Return the type of the calculated for of fvPatchField. More...

Static Public Member Functions inherited from Field< Type >
static const Field< Type > &	null ()
	Return a null field. More...

template<class Type2 >
static tmp< Field< Type > >	NewCalculatedType (const Field< Type2 > &f)
	Return a pointer to a new calculatedFvPatchFieldField created on. More...

Static Public Member Functions inherited from List< Type >
static const List< Type > &	null ()
	Return a null List. More...

Static Public Member Functions inherited from UList< Type >
static const UList< Type > &	null ()
	Return a null UList. More...

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField
	Debug switch to disallow the use of genericFvPatchField. More...

Static Public Attributes inherited from Field< Type >
static const char *const	typeName

Protected Member Functions inherited from List< Type >
void	size (const label)
	Override size to be inconsistent with allocated storage. More...

Detailed Description

template<class Type>
class Foam::advectiveFvPatchField< Type >

This boundary condition provides an advective outflow condition, based on solving DDt(psi, U) = 0 at the boundary.

The standard (Euler, backward, CrankNicolson) time schemes are supported. Additionally an optional mechanism to relax the value at the boundary to a specified far-field value is provided which is switched on by specifying the relaxation length-scale lInf and the far-field value fieldInf.

The flow/wave speed at the outlet is provided by the virtual function advectionSpeed() the default implementation of which requires the name of the flux field (phi) and optionally the density (rho) if the mass-flux rather than the volumetric-flux is given.

The flow/wave speed at the outlet can be changed by deriving a specialised BC from this class and over-riding advectionSpeed() e.g. in waveTransmissiveFvPatchField the advectionSpeed() calculates and returns the flow-speed plus the acoustic wave speed creating an acoustic wave transmissive boundary condition.

Patch usage

Property	Description	Required	Default value
`phi`	flux field name	no	phi
`rho`	density field name	no	rho
`fieldInf`	value of field beyond patch	no
`lInf`	distance beyond patch for `fieldInf`	no

Example of the boundary condition specification:

    myPatch
    {
        type            advective;
        phi             phi;
    }

Note: If lInf is specified, fieldInf will be required; rho is only required in the case of a mass-based flux.

Source files

Definition at line 118 of file advectiveFvPatchField.H.

Constructor & Destructor Documentation

advectiveFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 39 of file advectiveFvPatchField.C.

References p.

Referenced by advectiveFvPatchField< Type >::advectiveFvPatchField(), and advectiveFvPatchField< Type >::clone().

Here is the caller graph for this function:

advectiveFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 75 of file advectiveFvPatchField.C.

References advectiveFvPatchField< Type >::advectiveFvPatchField(), dict, dimensionedInternalField(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, dictionary::found(), dictionary::lookup(), Foam::nl, dictionary::readIfPresent(), and List< Type >::size().

Here is the call graph for this function:

advectiveFvPatchField	(	const advectiveFvPatchField< Type > &	,
		const fvPatch &	,
		const DimensionedField< Type, volMesh > &	,
		const fvPatchFieldMapper &
	)

Construct by mapping given advectiveFvPatchField.

onto a new patch

advectiveFvPatchField ( const advectiveFvPatchField< Type > & ptpsf )

Construct as copy.

Definition at line 131 of file advectiveFvPatchField.C.

References advectiveFvPatchField< Type >::advectiveFvPatchField().

Here is the call graph for this function:

advectiveFvPatchField	(	const advectiveFvPatchField< Type > &	ptpsf,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 145 of file advectiveFvPatchField.C.

Member Function Documentation

TypeName ( "advective" )

Runtime type information.

virtual tmp<fvPatchField<Type> > clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented from mixedFvPatchField< Type >.

Reimplemented in waveTransmissiveFvPatchField< Type >.

Definition at line 180 of file advectiveFvPatchField.H.

References advectiveFvPatchField< Type >::advectiveFvPatchField().

Here is the call graph for this function:

virtual tmp<fvPatchField<Type> > clone ( const DimensionedField< Type, volMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from mixedFvPatchField< Type >.

Reimplemented in waveTransmissiveFvPatchField< Type >.

Definition at line 197 of file advectiveFvPatchField.H.

const Type& fieldInf ( ) const

inline

Return the field at infinity.

Definition at line 213 of file advectiveFvPatchField.H.

References advectiveFvPatchField< Type >::fieldInf_.

Type& fieldInf ( )

inline

Return reference to the field at infinity to allow adjustment.

Definition at line 219 of file advectiveFvPatchField.H.

References advectiveFvPatchField< Type >::fieldInf_.

scalar lInf ( ) const

inline

Return the relaxation length-scale.

Definition at line 225 of file advectiveFvPatchField.H.

References advectiveFvPatchField< Type >::advectionSpeed(), advectiveFvPatchField< Type >::lInf_, advectiveFvPatchField< Type >::updateCoeffs(), and advectiveFvPatchField< Type >::write().

Here is the call graph for this function:

scalar& lInf ( )

inline

Return reference to the relaxation length-scale.

to allow adjustment

Definition at line 232 of file advectiveFvPatchField.H.

Foam::tmp< Foam::scalarField > advectionSpeed ( ) const

virtual

Calculate and return the advection speed at the boundary.

Reimplemented in waveTransmissiveFvPatchField< Type >.

Definition at line 162 of file advectiveFvPatchField.C.

References Foam::dimArea, Foam::dimDensity, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimVelocity, and phi.

Referenced by advectiveFvPatchField< Type >::lInf().

Here is the call graph for this function:

Here is the caller graph for this function:

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 192 of file advectiveFvPatchField.C.

References Foam::constant::atomic::alpha, dimensionedInternalField(), Foam::exit(), Foam::FatalError, FatalErrorIn, k, Foam::max(), mesh, Foam::name(), Foam::nl, GeometricField< Type, PatchField, GeoMesh >::oldTime(), and patchi.

Referenced by advectiveFvPatchField< Type >::lInf().

Here is the call graph for this function:

Here is the caller graph for this function:

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from mixedFvPatchField< Type >.

Reimplemented in waveTransmissiveFvPatchField< Type >.

Definition at line 305 of file advectiveFvPatchField.C.

References Foam::nl, and write().

Referenced by advectiveFvPatchField< Type >::lInf().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

word phiName_

protected

Name of the flux transporting the field.

Definition at line 127 of file advectiveFvPatchField.H.

word rhoName_

protected

Name of the density field used to normalise the mass flux.

if neccessary

Definition at line 131 of file advectiveFvPatchField.H.

Type fieldInf_

protected

Field value of the far-field.

Definition at line 134 of file advectiveFvPatchField.H.

Referenced by advectiveFvPatchField< Type >::fieldInf().

scalar lInf_

protected

Relaxation length-scale.

Definition at line 137 of file advectiveFvPatchField.H.

Referenced by advectiveFvPatchField< Type >::lInf().

The documentation for this class was generated from the following files:

src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::advectiveFvPatchField< Type >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class Type>
class Foam::advectiveFvPatchField< Type >