BezierDesignVariables Class Reference

Bezier design variables for shape optimisation. More...

Inheritance diagram for BezierDesignVariables:
Collaboration diagram for BezierDesignVariables:

Public Member Functions

 TypeName ("Bezier")
 Runtime type information. More...
 
 BezierDesignVariables (fvMesh &mesh, const dictionary &dict)
 Construct from components. More...
 
virtual ~BezierDesignVariables ()=default
 Destructor. More...
 
virtual void update (scalarField &correction)
 Update design variables based on a given correction. More...
 
virtual scalar computeEta (scalarField &correction)
 Compute eta if not set in the first step. More...
 
virtual bool globalSum () const
 Whether to use global sum when computing matrix-vector products. More...
 
virtual tmp< vectorFielddxdbFace (const label patchI, const label varID) const
 Get dxdb for given design variable and patch. More...
 
virtual tmp< vectorFielddndb (const label patchI, const label varID) const
 Get dndb for given design variable and patch. More...
 
virtual tmp< vectorFielddSdb (const label patchI, const label varID) const
 Get dSdb for given design variable and patch. More...
 
virtual tmp< volVectorFielddCdb (const label varID) const
 Get dCdb for given design variable. More...
 
- Public Member Functions inherited from shapeDesignVariables
 TypeName ("shape")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, shapeDesignVariables, dictionary,(fvMesh &mesh, const dictionary &dict),(mesh, dict))
 
 shapeDesignVariables (fvMesh &mesh, const dictionary &dict)
 Construct from components. More...
 
virtual ~shapeDesignVariables ()=default
 Destructor. More...
 
virtual bool readDict (const dictionary &dict)
 Read dictionary if changed. More...
 
virtual void storeDesignVariables ()
 Store design variables, as the starting point for line search. More...
 
virtual void resetDesignVariables ()
 Reset to starting point of line search. More...
 
virtual void moveMesh ()
 Move mesh based on displacementMethod. More...
 
const labelHashSetgetPatches () const
 Patches affected by the parameterisation. More...
 
autoPtr< displacementMethod > & returnDisplacementMethod ()
 Return displacementMethod. More...
 
virtual tmp< scalarFieldassembleSensitivities (adjointSensitivity &adjointSens)
 Add part of sensitivity derivatives related to geometry variations. More...
 
virtual void writeSensitivities (const scalarField &sens, const adjointSensitivity &adjointSens)
 Write final sensitivity derivatives to files. More...
 
virtual tmp< vectorFielddxdbVol (const label varID) const
 Get dxdb for all mesh points. More...
 
- Public Member Functions inherited from designVariables
 TypeName ("designVariables")
 Runtime type information. More...
 
 declareRunTimeNewSelectionTable (autoPtr, designVariables, designVariables,(fvMesh &mesh, const dictionary &dict),(mesh, dict))
 
 designVariables (fvMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
 designVariables (fvMesh &mesh, const dictionary &dict, const label size)
 Construct from dictionary and size. More...
 
virtual ~designVariables ()=default
 Destructor. More...
 
virtual const scalarFieldgetVars () const
 Get the design variables. More...
 
virtual scalarFieldgetVars ()
 Get the design variables. More...
 
const labelListactiveDesignVariables () const
 Return list of active design variables. More...
 
bool isMaxInitChangeSet () const
 Check whether the max. initial change of the design variables has been set. More...
 
const autoPtr< scalar > & getMaxInitChange ()
 Get maxInitChange. More...
 
void setMaxInitChange (const scalar maxInitChange)
 Set maxInitChange. More...
 
virtual bool resetEta () const
 Trigger the recomputation of eta by updateMethod. More...
 
const autoPtr< scalarField > & lowerBounds () const
 Get min bounds for the design variables. More...
 
const autoPtr< scalarField > & upperBounds () const
 Get max bounds for the design variables. More...
 
scalarFieldlowerBoundsRef ()
 Get min bounds for the design variables. More...
 
scalarFieldupperBoundsRef ()
 Get max bounds for the design variables. More...
 
virtual void postProcessSens (scalarField &objectiveSens, PtrList< scalarField > &constraintSens, const wordList &adjointSolversNames, bool isMaster)
 Post process sensitivities if needed. More...
 
virtual void evolveNumber ()
 For design variables with a dynamic character (i.e. changing number), perform the evolution. More...
 
virtual void setInitialValues ()
 Set initial values of the design variables. More...
 
virtual void addFvOptions (const PtrList< primalSolver > &primalSolver, const PtrList< adjointSolverManager > &adjointSolverManagers)
 Add fvOptions depending on the design variables. More...
 
virtual tmp< scalarFieldconstraintValues ()
 Design variables might add constraints related to themselves (e.g. linear combinations of the design variables) Return the values and gradients of these constraints. More...
 
virtual PtrList< scalarFieldconstraintDerivatives ()
 
virtual void writeDesignVars ()
 Write useful quantities to files. More...
 
- Public Member Functions inherited from Field< scalar >
constexpr Field () noexcept
 Default construct. More...
 
 Field (const label len)
 Construct given size. More...
 
 Field (const label len, const scalar &val)
 Construct given size and initial value. More...
 
 Field (const label len, const Foam::zero)
 Construct given size and initial values of zero. More...
 
 Field (const Foam::one, const scalar &val)
 Construct with length=1, copying the value as the only content. More...
 
 Field (const Foam::one, scalar &&val)
 Construct with length=1, moving the value as the only content. More...
 
 Field (const Foam::one, const Foam::zero)
 Construct with length=1, initializing content to zero. More...
 
 Field (const Field< scalar > &fld)
 Copy construct. More...
 
 Field (const UList< scalar > &list)
 Copy construct from UList<Type> More...
 
 Field (const IndirectListBase< scalar, Addr > &list)
 Copy construct from IndirectList. More...
 
 Field (Field< scalar > &&fld) noexcept
 Move construct from Field. More...
 
 Field (List< scalar > &&list) noexcept
 Move construct from List. More...
 
 Field (DynamicList< scalar, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 Field (const UList< scalar > &mapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given field. More...
 
 Field (const tmp< Field< scalar >> &tmapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given tmp field. More...
 
 Field (const UList< scalar > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given field. More...
 
 Field (const tmp< Field< scalar >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given tmp field. More...
 
 Field (const UList< scalar > &mapF, const FieldMapper &map, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const UList< scalar > &mapF, const FieldMapper &map, const scalar &defaultValue, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const UList< scalar > &mapF, const FieldMapper &map, const UList< scalar > &defaultValues, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const tmp< Field< scalar >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
 Construct by mapping from the given tmp field. More...
 
 Field (const tmp< Field< scalar >> &tmapF, const FieldMapper &map, const scalar &defaultValue, const bool applyFlip=true)
 Construct by mapping from the given tmp field. Uses supplied uniform value for unmapped items. More...
 
 Field (const tmp< Field< scalar >> &tmapF, const FieldMapper &map, const UList< scalar > &defaultValues, const bool applyFlip=true)
 Construct by mapping from the given tmp field. Uses supplied values for unmapped items. More...
 
 Field (Field< scalar > &fld, bool reuse)
 Copy construct or re-use as specified. More...
 
 Field (const tmp< Field< scalar >> &tfld)
 Copy or move construct from tmp. More...
 
 Field (Istream &is)
 Construct from Istream. More...
 
 Field (const entry &e, const label len)
 Construct from a dictionary (primitive) entry. More...
 
 Field (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
 Lookup of a primitive dictionary entry by (literal) name and assign its contents to this. The behaviour largely as described in assign(): More...
 
tmp< Field< scalar > > clone () const
 Clone. More...
 
void assign (const entry &e, const label len)
 Assign from a primitive dictionary entry with the following behaviour: More...
 
bool assign (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
 Lookup a primitive dictionary entry by (literal) name and assign its contents to this (behaviour as described above). More...
 
void map (const UList< scalar > &mapF, const labelUList &mapAddressing)
 1 to 1 map from the given field More...
 
void map (const tmp< Field< scalar >> &tmapF, const labelUList &mapAddressing)
 1 to 1 map from the given tmp field More...
 
void map (const UList< scalar > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given field. More...
 
void map (const tmp< Field< scalar >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given tmp field. More...
 
void map (const UList< scalar > &mapF, const FieldMapper &map, const bool applyFlip=true)
 Map from the given field. More...
 
void map (const tmp< Field< scalar >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
 Map from the given tmp field. More...
 
void autoMap (const FieldMapper &map, const bool applyFlip=true)
 Map from self. More...
 
void rmap (const UList< scalar > &mapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given field More...
 
void rmap (const tmp< Field< scalar >> &tmapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given tmp field More...
 
void rmap (const UList< scalar > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given field. More...
 
void rmap (const tmp< Field< scalar >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given tmp field. More...
 
void negate ()
 Inplace negate this field (negative). More...
 
void normalise ()
 Inplace normalise this field. Generally a no-op except for vector fields. More...
 
void normalise ()
 
void normalise ()
 
void normalise ()
 Inplace normalise (float) vector field. More...
 
void normalise ()
 Inplace normalise (double) vector 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...
 
void clamp_min (const scalar &lower)
 Impose lower (floor) clamp on the field values (in-place) More...
 
void clamp_max (const scalar &upper)
 Impose upper (ceiling) clamp on the field values (in-place) More...
 
void clamp_range (const scalar &lower, const scalar &upper)
 Clamp field values (in-place) to the specified range. More...
 
void clamp_range (const MinMax< scalar > &range)
 Clamp field values (in-place) to the specified range. More...
 
VSForm block (const label start) const
 
tmp< Field< scalar > > 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...
 
SubField< scalar > slice (const label pos, label len=-1)
 Return SubField slice (non-const access) - no range checking. More...
 
const SubField< scalar > slice (const label pos, label len=-1) const
 Return SubField slice (const access) - no range checking. More...
 
SubField< scalar > slice (const labelRange &range)
 Return SubField slice (non-const access) - with range checking. More...
 
const SubField< scalar > slice (const labelRange &range) const
 Return SubField slice (const access) - with range checking. More...
 
void operator= (const Field< scalar > &)
 Copy assignment. More...
 
void operator= (const tmp< Field< scalar >> &)
 
void operator= (const UList< scalar > &rhs)
 
void operator= (const SubField< scalar > &rhs)
 
void operator= (const IndirectListBase< scalar, Addr > &rhs)
 Copy assign from IndirectList. More...
 
void operator= (Field< scalar > &&rhs)
 Move assignment. More...
 
void operator= (List< scalar > &&rhs)
 
void operator= (DynamicList< scalar, SizeMin > &&rhs)
 
void operator= (const scalar &val)
 Assign entries to the given value. More...
 
void operator= (const Foam::zero)
 Assign entries to zero. More...
 
void operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
 
void operator= (const tmp< Field > &rhs)
 
void operator+= (const UList< scalar > &)
 
void operator+= (const tmp< Field< scalar >> &)
 
void operator+= (const scalar &)
 
void operator-= (const UList< scalar > &)
 
void operator-= (const tmp< Field< scalar >> &)
 
void operator-= (const scalar &)
 
void operator*= (const UList< scalar > &)
 
void operator*= (const tmp< Field< scalar >> &)
 
void operator*= (const scalar &)
 
void operator/= (const UList< scalar > &)
 
void operator/= (const tmp< Field< scalar >> &)
 
void operator/= (const scalar &)
 
- Public Member Functions inherited from FieldBase
constexpr FieldBase () noexcept
 Default construct. More...
 
- Public Member Functions inherited from refCount
constexpr refCount () noexcept
 Default construct, initializing count to 0. More...
 
int use_count () const noexcept
 Return the current reference count. More...
 
bool unique () const noexcept
 Return true if the reference count is zero. More...
 
void operator++ () noexcept
 Increment the reference count. More...
 
void operator++ (int) noexcept
 Increment the reference count. More...
 
void operator-- () noexcept
 Decrement the reference count. More...
 
void operator-- (int) noexcept
 Decrement the reference count. More...
 
- Public Member Functions inherited from List< scalar >
constexpr List () noexcept
 Default construct. More...
 
 List (const label len)
 Construct with given size. More...
 
 List (const label len, const scalar &val)
 Construct with given size and value for all elements. More...
 
 List (const label len, const Foam::zero)
 Construct with given size initializing all elements to zero. More...
 
 List (const Foam::one, const scalar &val)
 Construct with length=1, copying the value as the only content. More...
 
 List (const Foam::one, scalar &&val)
 Construct with length=1, moving the value as the only content. More...
 
 List (const Foam::one, const Foam::zero)
 Construct with length=1, initializing content to zero. More...
 
 List (const List< scalar > &list)
 Copy construct from list. More...
 
 List (const UList< scalar > &list)
 Copy construct contents from list. More...
 
 List (List< scalar > &list, bool reuse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< scalar > &list, const labelUList &indices)
 Copy construct subset of list. More...
 
 List (const UList< scalar > &list, const FixedList< label, N > &indices)
 Copy construct subset of list. More...
 
 List (const FixedList< scalar, N > &list)
 Construct as copy of FixedList<T, N> More...
 
 List (const PtrList< scalar > &list)
 Construct as copy of PtrList<T> More...
 
 List (const IndirectListBase< scalar, Addr > &list)
 Construct as copy of IndirectList contents. More...
 
 List (std::initializer_list< scalar > list)
 Construct from an initializer list. More...
 
 List (List< scalar > &&list) noexcept
 Move construct from List. More...
 
 List (DynamicList< scalar, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 List (Istream &is)
 Construct from Istream. More...
 
 List (const SLList< scalar > &list)
 Copy construct from SLList. More...
 
autoPtr< List< scalar > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void resize (const label len)
 Adjust allocated size of list. More...
 
void resize (const label len, const scalar &val)
 Adjust allocated size of list and set val for new elements. More...
 
void resize (const label newLen)
 
void resize_fill (const label len, const scalar &val)
 Adjust allocated size of list and set val for all elements. More...
 
void resize_nocopy (const label len)
 Adjust allocated size of list without necessarily. More...
 
void resize_unsafe (const label len) noexcept
 Change the addressed list size directly without affecting any memory management (advanced usage). More...
 
void setSize (const label n)
 Alias for resize() More...
 
void setSize (const label n, const scalar &val)
 Alias for resize() More...
 
void transfer (List< scalar > &list)
 Transfer the contents of the argument List into this list and annul the argument list. More...
 
void transfer (DynamicList< scalar, SizeMin > &list)
 Transfer the contents of the argument List into this list and annul the argument list. More...
 
scalar & newElmt (const label i)
 Return subscript-checked element of UList and resizing the list if required. More...
 
scalar & emplace_back (Args &&... args)
 Construct an element at the end of the list, return reference to the new list element. More...
 
void push_back (const scalar &val)
 Append an element at the end of the list. More...
 
void push_back (scalar &&val)
 Move append an element at the end of the list. More...
 
void push_back (const UList< scalar > &list)
 Append a List to the end of this list. More...
 
void push_back (const IndirectListBase< scalar, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label push_uniq (const scalar &val)
 Append an element if not already in the list. More...
 
void pop_back (label n=1)
 Reduce size by 1 or more elements. Can be called on an empty list. More...
 
void operator= (const UList< scalar > &list)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< scalar > &list)
 Assignment operator. Takes linear time. More...
 
void operator= (const IndirectListBase< scalar, Addr > &list)
 Assignment from IndirectList. Takes linear time. More...
 
void operator= (const FixedList< scalar, N > &list)
 Copy assignment from FixedList. More...
 
void operator= (std::initializer_list< scalar > list)
 Assignment to an initializer list. More...
 
void operator= (const scalar &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
void operator= (List< scalar > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (DynamicList< scalar, SizeMin > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (const SLList< scalar > &list)
 Copy assign from SLList in linear time. More...
 
IstreamreadList (Istream &is)
 Read List from Istream, discarding contents of existing List. More...
 
void shallowCopy (const UList< scalar > &)=delete
 No shallowCopy permitted. More...
 
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type set (const label i, bool val=true)
 A bitSet::set() method for a list of bool. More...
 
void append (const scalar &val)
 Append an element at the end of the list. More...
 
void append (scalar &&val)
 Move append an element at the end of the list. More...
 
void append (const UList< scalar > &list)
 Append a List to the end of this list. More...
 
void append (const IndirectListBase< scalar, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label appendUniq (const scalar &val)
 Same as push_uniq() More...
 
- Public Member Functions inherited from UList< T >
 UList (const UList< T > &)=default
 Copy construct. More...
 
constexpr UList () noexcept
 Default construct, zero-sized and nullptr. More...
 
 UList (T *__restrict__ v, const label len) noexcept
 Construct from components. More...
 
label fcIndex (const label i) const noexcept
 The forward circular index. The next index in the list which returns to the first at the end of the list. More...
 
label rcIndex (const label i) const noexcept
 The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More...
 
const TfcValue (const label i) const
 Return forward circular value (ie, next value in the list) More...
 
TfcValue (const label i)
 Return forward circular value (ie, next value in the list) More...
 
const TrcValue (const label i) const
 Return reverse circular value (ie, previous value in the list) More...
 
TrcValue (const label i)
 Return reverse circular value (ie, previous value in the list) More...
 
const Tcdata () const noexcept
 Return pointer to the underlying array serving as data storage. More...
 
Tdata () noexcept
 Return pointer to the underlying array serving as data storage. More...
 
const char * cdata_bytes () const noexcept
 Return pointer to the underlying array serving as data storage,. More...
 
char * data_bytes () noexcept
 Return pointer to the underlying array serving as data storage,. More...
 
Tfront ()
 Access first element of the list, position [0]. More...
 
const Tfront () const
 Access first element of the list. More...
 
Tback ()
 Access last element of the list, position [size()-1]. More...
 
const Tback () const
 Access last element of the list, position [size()-1]. More...
 
std::streamsize size_bytes () const noexcept
 Number of contiguous bytes for the List data. More...
 
std::streamsize byteSize () const
 Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More...
 
void checkStart (const label start) const
 Check start is within valid range [0,size) More...
 
void checkSize (const label size) const
 Check size is within valid range [0,size]. More...
 
void checkRange (const label start, const label len) const
 Check that start and length define a valid range. More...
 
void checkIndex (const label i) const
 Check index is within valid range [0,size) More...
 
bool uniform () const
 True if all entries have identical values, and list is non-empty. More...
 
bool contains (const T &val) const
 True if the value is contained in the list. More...
 
bool contains (const T &val, label pos, label len=-1) const
 Is the value contained in the list? More...
 
label find (const T &val) const
 Find index of the first occurrence of the value. More...
 
label find (const T &val, label pos, label len=-1) const
 Find index of the first occurrence of the value. More...
 
label rfind (const T &val, label pos=-1) const
 Find index of the last occurrence of the value. More...
 
void moveFirst (const label i)
 Move element to the first position. More...
 
void moveLast (const label i)
 Move element to the last position. More...
 
void swapFirst (const label i)
 Swap element with the first element. Fatal on an empty list. More...
 
void swapLast (const label i)
 Swap element with the last element. Fatal on an empty list. More...
 
void shallowCopy (T *__restrict__ ptr, const label len) noexcept
 Copy the pointer and size. More...
 
void shallowCopy (const UList< T > &list) noexcept
 Copy the pointer and size held by the given UList. More...
 
void deepCopy (const UList< T > &list)
 Copy elements of the given UList. Sizes must match! More...
 
template<class Addr >
void deepCopy (const IndirectListBase< T, Addr > &list)
 Copy elements of the given indirect list. Sizes must match! More...
 
SubList< Tslice (const label pos, label len=-1)
 Return SubList slice (non-const access) - no range checking. More...
 
const SubList< Tslice (const label pos, label len=-1) const
 Return SubList slice (const access) - no range checking. More...
 
SubList< Tslice (const labelRange &range)
 Return SubList slice (non-const access) - with range checking. More...
 
const SubList< Tslice (const labelRange &range) const
 Return SubList slice (const access) - with range checking. More...
 
Toperator[] (const label i)
 Return element of UList. More...
 
const Toperator[] (const label i) const
 Return element of constant UList. More...
 
 operator const Foam::List< T > & () const
 Allow cast to a const List<T>&. More...
 
void operator= (const T &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
iterator begin () noexcept
 Return an iterator to begin traversing the UList. More...
 
iterator end () noexcept
 Return an iterator to end traversing the UList. More...
 
iterator begin (const label i) noexcept
 Return iterator at offset i from begin, clamped to [0,size] range. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cend () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator begin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator end () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator cbegin (const label i) const noexcept
 Return const_iterator at offset i from begin, clamped to [0,size] range. More...
 
const_iterator begin (const label i) const noexcept
 Return const_iterator at offset i from begin, clamped to [0,size] range. More...
 
reverse_iterator rbegin ()
 Return 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 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...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
bool empty () const noexcept
 True if List is empty (ie, size() is zero) More...
 
label size () const noexcept
 The number of elements in the container. More...
 
label capacity () const noexcept
 Size of the underlying storage. More...
 
void swap (UList< T > &list) noexcept
 Swap content with another UList of the same type in constant time. More...
 
bool operator== (const UList< T > &list) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< T > &list) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< T > &list) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< T > &list) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< T > &list) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< T > &list) const
 Return true if !(a < b). Takes linear time. More...
 
IstreamreadList (Istream &is)
 Read List contents from Istream. More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the List as a dictionary entry with keyword. More...
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write List, with line-breaks in ASCII when length exceeds shortLen. More...
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type test (const label i) const
 Test bool value at specified position, always false for out-of-range access. More...
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type get (const label i) const
 Return bool value at specified position, always false for out-of-range access. More...
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type unset (const label i)
 Unset the bool entry at specified position, always false for out-of-range access. More...
 
Tfirst ()
 Access first element of the list, position [0]. More...
 
const Tfirst () const
 Access first element of the list. More...
 
Tlast ()
 Access last element of the list, position [size()-1]. More...
 
const Tlast () const
 Access last element of the list, position [size()-1]. More...
 
bool found (const T &val, label pos=0) const
 Same as contains() More...
 
template<>
const bool & operator[] (const label i) const
 
template<>
UPstream::commsStructoperator[] (const label procID)
 
template<>
const UPstream::commsStructoperator[] (const label procID) const
 
template<>
Foam::UPstream::commsStructoperator[] (const label procID)
 
template<>
const Foam::UPstream::commsStructoperator[] (const label procID) const
 

Protected Member Functions

void readBounds (autoPtr< scalar > lowerBoundPtr=nullptr, autoPtr< scalar > upperBoundPtr=nullptr)
 Read bounds for design variables, if present. More...
 
void setBounds (autoPtr< scalarField > &bounds, const vector &cpBounds)
 Set uniform bounds for all control points. More...
 
tmp< vectorFieldcomputeBoundaryDisplacement (const scalarField &correction)
 Transform the correction of design variables to control points' movement. More...
 
void decomposeVarID (label &cpI, label &dir, const label varID) const
 Decompose varID to cpID and direction. More...
 
- Protected Member Functions inherited from shapeDesignVariables
virtual label sensSize () const
 Size of the sensitivity derivatives. More...
 
virtual const labelListactiveSensitivities () const
 Active variables for which to compute sensitivities. More...
 
virtual tmp< volVectorFieldsolveMeshMovementEqn (const label patchI, const label varID) const
 Compute dxdb at the mesh cell centers by solving a Laplace PDE. More...
 
void allocateSensFields ()
 Allocate the fields assosiated with the computation of sensitivities. More...
 
void zeroSensFields ()
 Zero the fields assosiated with the computation of sensitivities. More...
 
- Protected Member Functions inherited from designVariables
void readBounds (autoPtr< scalar > lowerBoundPtr=nullptr, autoPtr< scalar > upperBoundPtr=nullptr)
 Read bounds for design variables, if present. More...
 
- Protected Member Functions inherited from UList< T >
void setAddressableSize (const label n) noexcept
 Set addressed size to be inconsistent with allocated storage. More...
 
void size (const label n)
 Older name for setAddressableSize. More...
 
void writeEntry (Ostream &os) const
 Write the UList with its compound type. More...
 
labelRange validateRange (const labelRange &requestedRange) const
 Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. More...
 
void fill_uniform (const T &val)
 Assign all entries to the given value. More...
 
void fill_uniform (const Foam::zero)
 Assign all entries to zero. More...
 
UList< T > & operator= (const UList< T > &)=delete
 No copy assignment (default: shallow copy) More...
 
template<>
void writeEntry (Ostream &os) const
 Character list writeEntry. More...
 
template<>
void operator= (const Foam::zero)
 Character list assign zero - avoids Foam::zero casting ambiguities. More...
 
template<>
void writeEntry (Ostream &os) const
 
template<>
void operator= (const Foam::zero)
 

Protected Attributes

Bezier bezier_
 The Bezier control points and auxiliary functions. More...
 
pointVectorField dx_
 Boundary movement due to the change in Bezier control points. More...
 
- Protected Attributes inherited from shapeDesignVariables
labelHashSet parametertisedPatches_
 Patches to be moved by the design variables. More...
 
autoPtr< displacementMethoddisplMethodPtr_
 Mesh movement mechanism. More...
 
autoPtr< pointFieldpointsInit_
 Store old points. Useful for line search. More...
 
bool writeEachMesh_
 Write the mesh points irrespective of whether this is a write time. More...
 
scalarField dxdbVolSens_
 Flow related term. More...
 
scalarField dxdbSurfSens_
 Flow related term. More...
 
scalarField dSdbSens_
 Term depending on delta(n dS)/delta b. More...
 
scalarField dndbSens_
 Term depending on delta(n)/delta b. More...
 
scalarField dxdbDirectSens_
 Term depending on delta(x)/delta b for objectives that directly depend on x. More...
 
scalarField dVdbSens_
 Term depending on delta(V)/delta b. More...
 
scalarField distanceSens_
 Term depending on distance differentiation. More...
 
scalarField optionsSens_
 Term depending on fvOptions. More...
 
scalarField bcSens_
 Term depending on the differenation of boundary conditions. More...
 
fileName derivativesFolder_
 Name of the sensitivity derivatives folder. More...
 
- Protected Attributes inherited from designVariables
fvMeshmesh_
 
dictionary dict_
 
labelList activeDesignVariables_
 Which of the design variables will be updated. More...
 
autoPtr< scalarFieldoldDesignVariables_
 Copy of old design variables. Useful when performing line-search. More...
 
autoPtr< scalar > maxInitChange_
 Maximum design variables' change in the first optimisation cycle. More...
 
autoPtr< scalarFieldlowerBounds_
 Lower bounds of the design variables. More...
 
autoPtr< scalarFieldupperBounds_
 Upper bounds of the design variables. More...
 

Additional Inherited Members

- Public Types inherited from Field< scalar >
typedef pTraits< scalar >::cmptType cmptType
 Component type. More...
 
typedef SubField< scalar > subField
 Declare type of subField. More...
 
- Public Types inherited from List< scalar >
typedef SubList< scalar > subList
 Declare type of subList. More...
 
- Public Types inherited from UList< T >
typedef T value_type
 The value type the list contains. More...
 
typedef Tpointer
 The pointer type for non-const access to value_type items. More...
 
typedef const Tconst_pointer
 The pointer type for const access to value_type items. More...
 
typedef Treference
 The type used for storing into value_type objects. More...
 
typedef const Tconst_reference
 The type used for reading from constant value_type objects. More...
 
typedef Titerator
 Random access iterator for traversing a UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing a UList. More...
 
typedef label size_type
 The type to represent the size of a UList. More...
 
typedef label difference_type
 The difference between iterator objects. More...
 
typedef std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator (non-const access) More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator (const access) More...
 
- Static Public Member Functions inherited from shapeDesignVariables
static autoPtr< shapeDesignVariablesNew (fvMesh &mesh, const dictionary &dict)
 Construct and return the selected shapeDesignVariables. More...
 
- Static Public Member Functions inherited from designVariables
static autoPtr< designVariablesNew (fvMesh &mesh, const dictionary &dict)
 Return a reference to the selected design variables. More...
 
- Static Public Member Functions inherited from Field< scalar >
static const Field< scalar > & null ()
 Return nullObject reference Field. More...
 
static autoPtr< Field< scalar > > New (Istream &is)
 Return a pointer to a new Field created on freestore. More...
 
static tmp< Field< scalar > > NewCalculatedType (const Field< Type2 > &f)
 Return a pointer to a new calculatedFvPatchFieldField created on freestore without setting patchField values. More...
 
- Static Public Member Functions inherited from List< scalar >
static const List< scalar > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< T >
static const UList< T > & null ()
 Return a UList reference to a nullObject. More...
 
static constexpr label max_size () noexcept
 The size of the largest possible UList. More...
 
- Static Public Attributes inherited from FieldBase
static const char *const typeName
 Typename for Field. More...
 
static bool allowConstructFromLargerSize = false
 Permit read construct from a larger size. More...
 

Detailed Description

Bezier design variables for shape optimisation.

Source files

Definition at line 48 of file BezierDesignVariables.H.

Constructor & Destructor Documentation

◆ BezierDesignVariables()

BezierDesignVariables ( fvMesh mesh,
const dictionary dict 
)

Construct from components.

Definition at line 137 of file BezierDesignVariables.C.

References setSize(), and Foam::Zero.

Here is the call graph for this function:

◆ ~BezierDesignVariables()

virtual ~BezierDesignVariables ( )
virtualdefault

Destructor.

Member Function Documentation

◆ readBounds()

void readBounds ( autoPtr< scalar >  lowerBoundPtr = nullptr,
autoPtr< scalar >  upperBoundPtr = nullptr 
)
protected

Read bounds for design variables, if present.

Definition at line 43 of file BezierDesignVariables.C.

References Foam::Zero.

◆ setBounds()

void setBounds ( autoPtr< scalarField > &  bounds,
const vector cpBounds 
)
protected

Set uniform bounds for all control points.

Definition at line 67 of file BezierDesignVariables.C.

References autoPtr< T >::reset(), and Foam::Zero.

Here is the call graph for this function:

◆ computeBoundaryDisplacement()

Foam::tmp< Foam::vectorField > computeBoundaryDisplacement ( const scalarField correction)
protected

Transform the correction of design variables to control points' movement.

Definition at line 85 of file BezierDesignVariables.C.

References Foam::correction(), forAll, and Foam::Zero.

Referenced by BezierDesignVariables::update().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ decomposeVarID()

void decomposeVarID ( label &  cpI,
label &  dir,
const label  varID 
) const
protected

Decompose varID to cpID and direction.

Definition at line 122 of file BezierDesignVariables.C.

◆ TypeName()

TypeName ( "Bezier"  )

Runtime type information.

◆ update()

void update ( scalarField correction)
virtual

Update design variables based on a given correction.

Implements shapeDesignVariables.

Definition at line 186 of file BezierDesignVariables.C.

References BezierDesignVariables::computeBoundaryDisplacement(), Foam::correction(), shapeDesignVariables::displMethodPtr_, BezierDesignVariables::dx_, shapeDesignVariables::moveMesh(), and Field< scalar >::operator+=().

Here is the call graph for this function:

◆ computeEta()

Foam::scalar computeEta ( scalarField correction)
virtual

Compute eta if not set in the first step.

Implements shapeDesignVariables.

Definition at line 202 of file BezierDesignVariables.C.

References Foam::correction(), Foam::endl(), Foam::Info, Foam::mag(), and Foam::max().

Here is the call graph for this function:

◆ globalSum()

bool globalSum ( ) const
virtual

Whether to use global sum when computing matrix-vector products.

in update methods

Implements shapeDesignVariables.

Definition at line 220 of file BezierDesignVariables.C.

◆ dxdbFace()

Foam::tmp< Foam::vectorField > dxdbFace ( const label  patchI,
const label  varID 
) const
virtual

Get dxdb for given design variable and patch.

Reimplemented from shapeDesignVariables.

Definition at line 227 of file BezierDesignVariables.C.

◆ dndb()

Foam::tmp< Foam::vectorField > dndb ( const label  patchI,
const label  varID 
) const
virtual

Get dndb for given design variable and patch.

Reimplemented from shapeDesignVariables.

Definition at line 239 of file BezierDesignVariables.C.

◆ dSdb()

Foam::tmp< Foam::vectorField > dSdb ( const label  patchI,
const label  varID 
) const
virtual

Get dSdb for given design variable and patch.

Reimplemented from shapeDesignVariables.

Definition at line 251 of file BezierDesignVariables.C.

◆ dCdb()

Foam::tmp< Foam::volVectorField > dCdb ( const label  varID) const
virtual

Get dCdb for given design variable.

Used for FI-based sensitivities

Reimplemented from shapeDesignVariables.

Definition at line 263 of file BezierDesignVariables.C.

References Foam::gSum(), and Foam::mag().

Here is the call graph for this function:

Member Data Documentation

◆ bezier_

Bezier bezier_
protected

The Bezier control points and auxiliary functions.

Definition at line 59 of file BezierDesignVariables.H.

◆ dx_

pointVectorField dx_
protected

Boundary movement due to the change in Bezier control points.

Definition at line 64 of file BezierDesignVariables.H.

Referenced by BezierDesignVariables::update().


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